@openfin/workspace-platform 5.3.0 → 5.3.1

package/README.md

@@ -1,4 +1,4 @@
-# Workspace Client API
+# Workspace Platform API
 
 The Workspace Platform Client APIs allow integrators to create their own Workspace platforms.
 
@@ -10,13 +10,40 @@ Run `npm i -E @openfin/workspace-platform`.
 
 ## Workspace Platform API documentation
 
--   [Overview](https://developers.openfin.co/of-docs/doc/)
--   [API Reference](https://cdn.openfin.co/workspace/api/platform/docs/)
+-   [Overview](https://developers.openfin.co/of-docs/docs/workspace-sdk)
+-   [API Reference](https://cdn.openfin.co/workspace/api/platform/docs/latest/index.html)
+-   [Example projects using Workspace Platform](https://github.com/built-on-openfin/workspace-starter)
 
 ## Code examples
 
+### Initilaize a Workspace Platform
+
 ```typescript
 import * as WorkspacePlatform from '@openfin/workspace-platform';
 
-WorkspacePlatform.init();
+const customThemes: WorkspacePlatform.CustomThemes = [
+    {
+        label: "OpenFin's Custom Theme",
+        palette: {
+            brandPrimary: ‘#F51F63, // required
+            brandSecondary: ‘#1FF58A’, // required
+            backgroundPrimary: ‘#F8E71C’, // required - hex, rgb/rgba, hsl/hsla only - no string colors: ‘red’
+            background2: ‘#7D808A’ // any of the optional colors
+        }
+    }
+];
+
+const overrideCallback: WorkspacePlatform.BrowserOverrideCallback = async (WorkspacePlatformProvider) => {
+    class Override extends WorkspacePlatformProvider {
+        async quit(payload, callerIdentity) {
+            return super.quit(payload, callerIdentity);
+        }
+    }
+    return new Override();
+};
+
+await WorkspacePlatform.init({
+    browser: { overrideCallback },
+    theme: customThemes
+});
 ```

package/client-api/src/shapes.d.ts

@@ -4,11 +4,12 @@
  */
 import type { Page } from '../../common/src/api/pages/shapes';
 import type { Workspace } from '../../common/src/api/workspaces';
-import type { Action, DispatchedSearchResult, SearchListenerRequest, SearchListenerResponse, SearchProvider, SearchResult } from '../../search-api/src';
-export type { Action, DispatchedSearchResult, SearchListenerRequest, SearchListenerResponse, SearchProviderInfo, SearchResult, ScoreOrder, SearchTag, SearchProvider, UserInputListener, ResultDispatchListener, SearchResponse } from '../../search-api/src';
+import type { Action, DispatchedSearchResult, SearchListenerRequest, SearchListenerResponse, SearchProvider, SearchResult } from '../../search-api/src/index';
+export type { Action, DispatchedSearchResult, SearchListenerRequest, SearchListenerResponse, SearchProviderInfo, SearchResult, ScoreOrder, SearchTag, SearchProvider, UserInputListener, ResultDispatchListener, SearchResponse } from '../../search-api/src/index';
 export type { Workspace } from '../../common/src/api/workspaces';
-export type { Page } from '../../common/src/api/pages/shapes';
-export { SearchTagBackground } from '../../search-api/src';
+export type { LayoutExtended, LayoutContentExtended, LayoutSettingsExtended, LayoutContentItemExtended, LayoutComponentExtended, LayoutComponentStateExtended, LayoutStack } from '../../common/src/utils/layout';
+export type { Page, PageLayout, PageLayoutDetails } from '../../common/src/api/pages/shapes';
+export { SearchTagBackground } from '../../search-api/src/index';
 /**
  * Describes the type of the app directory entry `manifest` attributes.
  * Launch mechanics are determined by the manifest type.

package/client-api-platform/src/api/app-directory.d.ts

@@ -1,7 +1,7 @@
-import type { LaunchAppPayload } from '../shapes';
+import type { LaunchAppRequest } from '../shapes';
 /**
  * Launch the app described by an App Directory entry.
  * @param app the app directory entry.
  * @param opts launch options.
  */
-export declare function launchApp({ app, target }: LaunchAppPayload): Promise<void | import("openfin-adapter").View | import("openfin-adapter").Application | import("openfin-adapter/src/api/platform").Platform | import("openfin-adapter").Identity>;
+export declare function launchApp({ app, target }: LaunchAppRequest): Promise<void | import("openfin-adapter").View | import("openfin-adapter").Application | import("openfin-adapter/src/api/platform").Platform | import("openfin-adapter").Identity>;

package/client-api-platform/src/api/browser/browser-module.d.ts

@@ -1,11 +1,11 @@
 /// <reference types="openfin-adapter/fin" />
-import type { AttachedPage, Page } from '@common/api/pages/shapes';
+import type { AttachedPage, Page, PageWithUpdatableRuntimeAttribs } from '../../../../common/src/api/pages/shapes';
 export declare const getBrowserModule: (identity: OpenFin.Identity) => {
     identity: OpenFin.Identity;
     openfinWindow: import("openfin-adapter").Window;
     getPages: () => Promise<AttachedPage[]>;
     getPage: (pageId: string) => Promise<AttachedPage>;
-    addPage: (page: Page) => Promise<void>;
+    addPage: (page: PageWithUpdatableRuntimeAttribs) => Promise<void>;
     removePage: (id: Page['pageId']) => Promise<void>;
     setActivePage: (id: Page['pageId']) => Promise<void>;
     updatePage: (req: any) => Promise<any>;

package/client-api-platform/src/api/browser/index.d.ts

@@ -1,20 +1,20 @@
 /// <reference types="openfin-adapter/fin" />
-import type { AttachedPage, Page } from '@common/api/pages/shapes';
+import type { AttachedPage, Page } from '../../../../common/src/api/pages/shapes';
 import type { BrowserCreateWindowRequest, BrowserWindowModule } from '../../shapes';
-export declare const getBrowserApi: (identity: OpenFin.Identity) => {
+export declare const getBrowserApi: (identity: OpenFin.ApplicationIdentity) => {
     wrapSync: (windowIdentity: OpenFin.Identity) => {
         identity: OpenFin.Identity;
         openfinWindow: import("openfin-adapter").Window;
         getPages: () => Promise<AttachedPage[]>;
         getPage: (pageId: string) => Promise<AttachedPage>;
-        addPage: (page: Page) => Promise<void>;
+        addPage: (page: import("@common/api/pages/shapes").PageWithUpdatableRuntimeAttribs) => Promise<void>;
         removePage: (id: string) => Promise<void>;
         setActivePage: (id: string) => Promise<void>;
         updatePage: (req: any) => Promise<any>;
         reorderPages: (req: any) => Promise<any>;
     };
     createWindow: (options: BrowserCreateWindowRequest) => Promise<BrowserWindowModule>;
-    getOpenPages: () => Promise<AttachedPage[]>;
+    getAllAttachedPages: () => Promise<AttachedPage[]>;
     getAllWindows: () => Promise<BrowserWindowModule[]>;
     launchPage: (page: Page) => Promise<BrowserWindowModule>;
     getUniquePageTitle: (title?: string) => Promise<any>;

package/client-api-platform/src/api/pages/helper.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="openfin-adapter/fin" />
-import { SnapshotExtended } from '@common/utils/snapshot';
+import { SnapshotExtended } from '../../../../common/src/utils/snapshot';
 /**
  * Get a snapshot with pages.
  *

package/client-api-platform/src/api/pages/index.d.ts

@@ -1,11 +1,11 @@
 /// <reference types="openfin-adapter/fin" />
-import type { AttachPagesToWindowPayload } from '@common/api/pages/shapes';
-import type { CreateSavedPageRequest, Page, UpdateSavedPageRequest } from '@client-platform/shapes';
+import type { AttachPagesToWindowPayload } from '../../../../common/src/api/pages/shapes';
+import type { CreateSavedPageRequest, Page, UpdateSavedPageRequest } from '../../../../client-api-platform/src/shapes';
 /**
  * Get all open pages in which are attached to a window.
  * @returns the list of attached pages.
  */
-export declare const getOpenPages: () => Promise<import("@common/api/pages/shapes").AttachedPage[]>;
+export declare const getAllAttachedPages: () => Promise<import("@client-platform/shapes").AttachedPage[]>;
 export declare const createSavedPageInternal: ({ page }: CreateSavedPageRequest) => Promise<void>;
 export declare const deleteSavedPageInternal: (id: string) => Promise<void>;
 export declare const updateSavedPageInternal: ({ pageId, page }: UpdateSavedPageRequest) => Promise<any>;
@@ -13,12 +13,12 @@ export declare const savePage: (page: Page) => Promise<any>;
 export declare const attachPagesToWindow: (payload: AttachPagesToWindowPayload) => Promise<void>;
 export declare const updatePageForWindow: (payload: any) => Promise<void>;
 export declare const detachPagesFromWindow: (payload: any) => Promise<void>;
-export declare const setActivePageForWindow: (payload: any) => Promise<void>;
-export declare const getPagesForWindow: (identity: OpenFin.Identity) => Promise<import("@common/api/pages/shapes").AttachedPage[]>;
+export declare const setActivePage: (payload: any) => Promise<void>;
+export declare const getPagesForWindow: (identity: OpenFin.Identity) => Promise<import("@client-platform/shapes").AttachedPage[]>;
 export declare const getPageForWindow: ({ identity, pageId }: {
     identity: any;
     pageId: any;
-}) => Promise<import("@common/api/pages/shapes").AttachedPage>;
+}) => Promise<import("@client-platform/shapes").AttachedPage>;
 export declare const reorderPagesForWindow: (payload: any) => Promise<void>;
 export declare const getActivePageIdForWindow: (identity: any) => Promise<string>;
 /**

package/client-api-platform/src/api/protocol.d.ts

@@ -25,14 +25,15 @@ export declare enum ChannelAction {
     AttachPagesToWindow = "attachPagesToWindow",
     DetachPagesFromWindow = "detachPagesFromWindow",
     ReorderPagesForWindow = "reorderPagesForWindow",
-    SetActivePageForWindow = "setActivePageForWindow",
-    GetOpenPages = "getOpenPages",
+    SetActivePage = "setActivePage",
+    GetAllAttachedPages = "getAllAttachedPages",
     GetActivePageIdForWindow = "getActivePageIdForWindow",
     GetPagesForWindow = "getPagesForWindow",
     GetPageForWindow = "getPageForWindow",
     GetSavedPageMetadata = "getSavedPageMetadata",
     GetUniquePageTitle = "getUniquePageTitle",
-    GetLastFocusedBrowserWindow = "getLastFocusedBrowserWindow"
+    GetLastFocusedBrowserWindow = "getLastFocusedBrowserWindow",
+    GetThemes = "getThemes"
 }
 /**
  * Get a channel client for a specific Workspace platform.
@@ -44,4 +45,4 @@ export declare enum ChannelAction {
  *
  * @returns the channel client for the Workspace platform.
  */
-export declare const getChannelClient: (identity: OpenFin.Identity) => Promise<import("openfin-adapter").ChannelClient>;
+export declare const getChannelClient: (identity: OpenFin.ApplicationIdentity) => Promise<import("openfin-adapter").ChannelClient>;

package/client-api-platform/src/api/storage.d.ts

@@ -1,4 +1,4 @@
-import { Page } from '@common/api/pages/shapes';
+import { Page } from '../../../common/src/api/pages/shapes';
 import type { CreateSavedPageRequest, UpdateSavedPageRequest } from '../shapes';
 export declare const getStorageApi: (identity: any) => {
     createPage: (req: CreateSavedPageRequest) => Promise<any>;

package/client-api-platform/src/api/theming.d.ts

@@ -0,0 +1,5 @@
+/// <reference types="openfin-adapter/fin" />
+import type { CustomThemes } from '../../../common/src/api/theming';
+export declare const getThemingApi: (identity: OpenFin.ApplicationIdentity) => {
+    getThemes: () => Promise<CustomThemes>;
+};

package/client-api-platform/src/api/workspace-module.d.ts

@@ -1,3 +1,3 @@
 /// <reference types="openfin-adapter/fin" />
 import type { WorkspacePlatformModule } from '../shapes';
-export declare const getWorkspacePlatformModule: (identity: OpenFin.Identity) => WorkspacePlatformModule;
+export declare const getWorkspacePlatformModule: (identity: OpenFin.ApplicationIdentity) => WorkspacePlatformModule;

package/client-api-platform/src/index.d.ts

@@ -1,6 +1,41 @@
 /// <reference types="openfin-adapter/fin" />
 import type { WorkspacePlatformInitConfig, WorkspacePlatformModule } from './shapes';
 export * from './shapes';
+/**
+ * Initilaize a Workspace Platform.
+ *
+ * ```ts
+ * import * as WorkspacePlatform from '@openfin/workspace-platform';
+ *
+ * const customThemes: WorkspacePlatform.CustomThemes = [{
+ *   label: "OpenFin's Custom Theme",
+ *   palette: {
+ *      brandPrimary: '#F51F63, // required
+ *      brandSecondary: '#1FF58A', // required
+ *      backgroundPrimary: '#F8E71C', // required - hex, rgb/rgba, hsl/hsla only - no string colors: 'red'
+ *      background2: '#7D808A' // any of the optional colors
+ *   }
+ * }
+ *
+ * const overrideCallback: WorkspacePlatform.BrowserOverrideCallback = async (
+ *    WorkspacePlatformProvider
+ * ) => {
+ *   class Override extends WorkspacePlatformProvider {
+ *       async quit(payload, callerIdentity) {
+ *           return super.quit(payload, callerIdentity);
+ *       }
+ *   }
+ *   return new Override();
+ * };
+ *
+ *
+ * await WorkspacePlatform.init({
+ *  browser: { overrideCallback },
+ *  theme: customThemes
+ * });
+ * ```
+ * @param options options for configuring the platform.
+ */
 export declare const init: (options: WorkspacePlatformInitConfig) => Promise<void>;
-export declare const wrapSync: (identity: OpenFin.Identity) => WorkspacePlatformModule;
+export declare const wrapSync: (identity: OpenFin.ApplicationIdentity) => WorkspacePlatformModule;
 export declare const getCurrentSync: () => WorkspacePlatformModule;

package/client-api-platform/src/init/override-callback.d.ts

@@ -1,3 +1,3 @@
 /// <reference types="openfin-adapter/fin" />
-import type { BrowserInitConfig } from '@client-platform/shapes';
+import type { BrowserInitConfig } from '../../../client-api-platform/src/shapes';
 export declare const getOverrideCallback: (initOptions: BrowserInitConfig) => OpenFin.OverrideCallback<OpenFin.PlatformProvider>;

package/client-api-platform/src/init/theming.d.ts

@@ -0,0 +1,9 @@
+import { CustomThemes } from '../shapes';
+export declare const getThemes: () => CustomThemes;
+/**
+ * initTheming()
+ * Accepts an array of CustomThemes objects and stores it
+ * @param customPaletteOptions - optional - array of custom color pallettes
+ * @returns array of custom theme objects
+ */
+export default function initTheming(customPalettes: CustomThemes): void;

package/client-api-platform/src/init/utils.d.ts

@@ -1,5 +1,10 @@
 /// <reference types="openfin-adapter/fin" />
-export declare function overrideViewOptions(options: Partial<OpenFin.ViewOptions>): void;
+import { Identity } from 'openfin-adapter';
+import { BrowserCreateWindowRequest } from '..';
+export declare function overrideViewOptions(options: Partial<OpenFin.ViewOptions>, initOptions: OpenFin.ViewOptions): OpenFin.ViewOptions & Partial<OpenFin.ViewOptions>;
+export declare function preserveInteropIfManifestConflict(opts: Partial<OpenFin.ViewOptions>, fetchManifest: ({ manifestUrl: string }: {
+    manifestUrl: any;
+}, callerIdentity: Identity) => any, callerIdentity: Identity): Promise<any>;
 export declare const filterSnapshotWindows: (win: OpenFin.WindowOptions) => boolean;
 /**
  * fitToMonitor()
@@ -35,5 +40,5 @@ export declare const initWorkspacePlatformOptions: (options: LegacyWindowOptions
  * @param options - options used to handle layout settings
  * @returns processed or unprocesseed options
  */
-export declare const applyBrowserDefaults: (options: OpenFin.PlatformWindowCreationOptions) => OpenFin.PlatformWindowCreationOptions;
+export declare const applyBrowserDefaults: (options: OpenFin.PlatformWindowCreationOptions, initOptions: BrowserCreateWindowRequest) => OpenFin.PlatformWindowCreationOptions;
 export {};