@openfin/workspace 45.1.0-alpha.76fdf8b1 → 45.1.0-alpha.9e06d950

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;
@@ -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 {};
@@ -3074,9 +3074,28 @@ export interface BrowserInitConfig {
3074
3074
  /** 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`. */
3075
3075
  defaultPageOptions?: Pick<Page, 'iconUrl' | 'unsavedIconUrl' | 'closeButton' | 'panels'>;
3076
3076
  /**
3077
- * 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.
3077
+ * 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.
3078
+ *
3079
+ * @example
3080
+ * ```ts
3081
+ * import * as WorkspacePlatform from '@openfin/workspace-platform';
3082
+ *
3083
+ * await WorkspacePlatform.init({
3084
+ * browser: {
3085
+ * defaultViewOptions: {
3086
+ * workspacePlatform: {
3087
+ * browserNavigationButtons: {
3088
+ * back: true,
3089
+ * forward: true,
3090
+ * reload: true
3091
+ * }
3092
+ * }
3093
+ * }
3094
+ * }
3095
+ * });
3096
+ * ```
3078
3097
  */
3079
- defaultViewOptions?: Partial<OpenFin.ViewOptions>;
3098
+ defaultViewOptions?: Partial<BrowserCreateViewRequest>;
3080
3099
  /**
3081
3100
  * The platform title. UI friendly title for the platform in browser.
3082
3101
  */
@@ -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;
@@ -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/",
@@ -84,13 +84,13 @@
84
84
  "type": "explicit",
85
85
  "version": "^4.0.11",
86
86
  "packageName": "common/package.json",
87
- "issuer": "common/src/api/pages/idb.ts"
87
+ "issuer": "common/src/utils/create-and-migrate-ibd-store.ts"
88
88
  },
89
89
  {
90
90
  "type": "explicit",
91
91
  "version": "^4.0.11",
92
92
  "packageName": "common/package.json",
93
- "issuer": "common/src/utils/create-and-migrate-ibd-store.ts"
93
+ "issuer": "common/src/api/pages/idb.ts"
94
94
  }
95
95
  ]
96
96
  }