@openfin/workspace-platform 4.15.0 → 4.19.0

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/browser/browser-module.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="openfin-adapter/fin" />
-import type { AttachedPage, Page, PageWithUpdatableRuntimeAttribs } 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;

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

@@ -1,5 +1,5 @@
 /// <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.ApplicationIdentity) => {
     wrapSync: (windowIdentity: OpenFin.Identity) => {

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,6 +1,6 @@
 /// <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.

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

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

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/shapes.d.ts

@@ -1,8 +1,8 @@
 /// <reference types="openfin-adapter/fin" />
 import type { InteropBroker } from 'openfin-adapter/src/api/interop';
-import type { App } from '../../client-api/src/shapes';
 import type { AttachedPage, Page, PageWithUpdatableRuntimeAttribs } from '../../common/src/api/pages/shapes';
 import type { CustomThemes } from '../../common/src/api/theming';
+import type { App } from '../../client-api/src/shapes';
 export type { CustomThemes } from '../../common/src/api/theming';
 export type { App, Image, AppIntent } from '../../client-api/src/shapes';
 export { AppManifestType } from '../../client-api/src/shapes';
@@ -43,16 +43,23 @@ export interface UpdateAttachedPageRequest {
  * Request for creating a browser window.
  */
 export interface BrowserCreateWindowRequest extends Omit<OpenFin.PlatformWindowCreationOptions, 'workspacePlatform'> {
+    /** WorkspacePlatform specific window options. These options will not work unless a workspace platform has been initialized. */
     workspacePlatform: {
         /** The initial set of pages to add to the created browser window. */
         pages: Page[];
-        /** The favicon to display on the top right of the created browser window. */
+        /** The favicon to display on the top left of the created browser window. */
         favicon?: string;
         /** A UI friendly title for the created browser window. */
         title?: string;
-        /** A URL to use when creating a new tab. */
+        /**
+         * Landing page that shows up when you add a new tab from the plus button that exists in the tabstrip.
+         * 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.
+         */
         newTabUrl?: string;
-        /** A URL to use when creating the initial tab in a new page. */
+        /**
+         * 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.
+         * 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.
+         */
         newPageUrl?: string;
     };
 }
@@ -79,9 +86,10 @@ export interface BrowserWindowModule {
      * Get a page that is attached to the browser window.
      *
      * ```ts
-     * import * as WorkspacePlatform from '@client-platform/index';
+     * import * as WorkspacePlatform from '@openfin/workspace-platform';
      *
      * const workspacePlatform = WorkspacePlatform.getCurrentSync();
+     * // assume a browser window already exists
      * const windows = await workspacePlatform.Browser.getAllWindows();
      * const page = await windows[0].getPage('MyPageId');
      * ```
@@ -92,9 +100,10 @@ export interface BrowserWindowModule {
      * Return all the pages that are attached to a browser window.
      *
      * ```ts
-     * import * as WorkspacePlatform from '@client-platform/index';
+     * import * as WorkspacePlatform from '@openfin/workspace-platform';
      *
      * const workspacePlatform = WorkspacePlatform.getCurrentSync();
+     * // assume a browser window already exists
      * const windows = await workspacePlatform.Browser.getAllWindows();
      * const pages = await windows[0].getPages();
      * ```
@@ -104,9 +113,10 @@ export interface BrowserWindowModule {
      * Set the active page for the browser window.
      *
      * ```ts
-     * import * as WorkspacePlatform from '@client-platform/index';
+     * import * as WorkspacePlatform from '@openfin/workspace-platform';
      *
      * const workspacePlatform = WorkspacePlatform.getCurrentSync();
+     * // assume a browser window already exists
      * const windows = await workspacePlatform.Browser.getAllWindows();
      * await windows[0].setActivePage('MyPageId');
      * ```
@@ -118,7 +128,7 @@ export interface BrowserWindowModule {
      * If a page with same id or title is attached to an existing browser window, an error will be thrown.
      *
      * ```ts
-     * import * as WorkspacePlatform from '@client-platform/index';
+     * import * as WorkspacePlatform from '@openfin/workspace-platform';
      *
      * const workspacePlatform = WorkspacePlatform.getCurrentSync();
      * const layout = {
@@ -143,6 +153,7 @@ export interface BrowserWindowModule {
      *      pageId: 'myPageId',
      *      layout
      * };
+     * // assume a browser window already exists
      * const windows = await workspacePlatform.Browser.getAllWindows();
      * await windows[0].addPage(page);
      * ```
@@ -151,16 +162,69 @@ export interface BrowserWindowModule {
     addPage(page: PageWithUpdatableRuntimeAttribs): Promise<void>;
     /**
      * Remove an attached page from the browser window.
+     *
+     * ```ts
+     * import * as WorkspacePlatform from '@openfin/workspace-platform';
+     *
+     * const workspacePlatform = WorkspacePlatform.getCurrentSync();
+     * // assume a browser window already exists
+     * const windows = await workspacePlatform.Browser.getAllWindows();
+     * await windows[0].removePage('myPageId');
+     * ```
      * @param id the id of the attached page to remove from the browser window.
      */
     removePage(id: string): Promise<void>;
     /**
      * Update a page in which is attached to the browser window.
+     *
+     * ```ts
+     * import * as WorkspacePlatform from '@openfin/workspace-platform';
+     *
+     * const workspacePlatform = WorkspacePlatform.getCurrentSync();
+     * const layout = {
+     *      content: [
+     *          {
+     *              type: 'stack',
+     *              content: [
+     *                  {
+     *                      type: 'component',
+     *                      componentName: 'view',
+     *                      componentState: {
+     *                          name: 'myViewName',
+     *                          url: 'http://google.com'
+     *                      }
+     *                  }
+     *              ]
+     *           }
+     *      ]
+     * };
+     * const page = {
+     *      title: 'myPageTitle',
+     *      pageId: 'myPageId',
+     *      layout
+     * };
+     * // assume a browser window already exists
+     * const windows = await workspacePlatform.Browser.getAllWindows();
+     * const req = {
+     *      pageId: 'myPageId',
+     *      page
+     * };
+     * await windows[0].updatePage(req);
+     * ```
      * @param req the update request.
      */
     updatePage(req: UpdateAttachedPageRequest): Promise<void>;
     /**
      * Reorder pages attached to the browser window.
+     *
+     * ```ts
+     * import * as WorkspacePlatform from '@openfin/workspace-platform';
+     *
+     * const workspacePlatform = WorkspacePlatform.getCurrentSync();
+     * // assume a browser window already exists and has three pages in it
+     * const windows = await workspacePlatform.Browser.getAllWindows();
+     * await windows[0].reorderPages(['myPageId2', 'myPageId1', 'myPageId3']);
+     * ```
      * @param req the reorder pages request.
      */
     reorderPages(req: ReorderPagesRequest): Promise<void>;
@@ -179,7 +243,7 @@ export interface BrowserWindowFactory {
      * Get a list of all pages that are attached to any running browser window.
      *
      * ```ts
-     * import * as WorkspacePlatform from '@client-platform/index';
+     * import * as WorkspacePlatform from '@openfin/workspace-platform';
      *
      * const workspacePlatform = WorkspacePlatform.getCurrentSync();
      * const attachedPages = await workspacePlatform.Browser.getAllAttachedPages();
@@ -190,7 +254,7 @@ export interface BrowserWindowFactory {
      *  Get all the Browser Windows that are running in the Workspace Platform.
      *
      * ```ts
-     * import * as WorkspacePlatform from '@client-platform/index';
+     * import * as WorkspacePlatform from '@openfin/workspace-platform';
      *
      * const workspacePlatform = WorkspacePlatform.getCurrentSync();
      * const windows = await workspacePlatform.Browser.getAllWindows();
@@ -201,7 +265,7 @@ export interface BrowserWindowFactory {
      * Create a new browser window.
      *
      * ```ts
-     * import * as WorkspacePlatform from '@client-platform/index';
+     * import * as WorkspacePlatform from '@openfin/workspace-platform';
      *
      * const workspacePlatform = WorkspacePlatform.getCurrentSync();
      * const layout = {
@@ -241,11 +305,25 @@ export interface BrowserWindowFactory {
     createWindow(options: BrowserCreateWindowRequest): Promise<BrowserWindowModule>;
     /**
      * Get a unique title for a page.
+     *
+     * ```ts
+     * import * as WorkspacePlatform from '@openfin/workspace-platform';
+     *
+     * const workspacePlatform = WorkspacePlatform.getCurrentSync();
+     * const uniqueTitle = await workspacePlatform.Browser.getUniquePageTitle('myTitle');
+     * ```
      * @param title a prefix for the title.
      */
     getUniquePageTitle(title?: string): Promise<string>;
     /**
      * Get the identity of the last focused Browser window.
+     *
+     * ```ts
+     * import * as WorkspacePlatform from '@openfin/workspace-platform';
+     *
+     * const workspacePlatform = WorkspacePlatform.getCurrentSync();
+     * const windowIdentity = await workspacePlatform.Browser.getLastFocusedWindow();
+     * ```
      */
     getLastFocusedWindow(): Promise<OpenFin.Identity>;
 }
@@ -255,25 +333,108 @@ export interface BrowserWindowFactory {
 export interface WorkspacePlatformStorage {
     /**
      * Get all pages that are saved in persistent storage.
+     *
+     * ```ts
+     * import * as WorkspacePlatform from '@openfin/workspace-platform';
+     *
+     * const workspacePlatform = WorkspacePlatform.getCurrentSync();
+     * const pages = await workspacePlatform.Storage.getPages();
+     * ```
      */
     getPages(): Promise<Page[]>;
     /**
      * Get a specific page in persistent storage.
+     *
+     * ```ts
+     * import * as WorkspacePlatform from '@openfin/workspace-platform';
+     *
+     * const workspacePlatform = WorkspacePlatform.getCurrentSync();
+     * const myPage = await workspacePlatform.Storage.getPage('myPageId');
+     * ```
      * @param id the id of the page to get.
      */
     getPage(id: string): Promise<Page>;
     /**
      * Create a page in persistent storage.
+     *
+     * ```ts
+     * import * as WorkspacePlatform from '@openfin/workspace-platform';
+     *
+     * const workspacePlatform = WorkspacePlatform.getCurrentSync();
+     * const layout = {
+     *      content: [
+     *          {
+     *              type: 'stack',
+     *              content: [
+     *                  {
+     *                      type: 'component',
+     *                      componentName: 'view',
+     *                      componentState: {
+     *                          name: 'myViewName',
+     *                          url: 'http://google.com'
+     *                      }
+     *                  }
+     *              ]
+     *           }
+     *      ]
+     * };
+     * const page = {
+     *      title: 'myPageTitle',
+     *      pageId: 'myPageId',
+     *      layout
+     * };
+     * await workspacePlatform.Storage.createPage({page});
+     * ```
      * @param page the page to create in persistent storage.
      */
     createPage(page: CreateSavedPageRequest): Promise<void>;
     /**
      * Update a page in persistent storage.
+     *
+     * ```ts
+     * import * as WorkspacePlatform from '@openfin/workspace-platform';
+     *
+     * const workspacePlatform = WorkspacePlatform.getCurrentSync();
+     * const layout = {
+     *      content: [
+     *          {
+     *              type: 'stack',
+     *              content: [
+     *                  {
+     *                      type: 'component',
+     *                      componentName: 'view',
+     *                      componentState: {
+     *                          name: 'myViewName',
+     *                          url: 'http://google.com'
+     *                      }
+     *                  }
+     *              ]
+     *           }
+     *      ]
+     * };
+     * const page = {
+     *      title: 'myPageTitle',
+     *      pageId: 'myPageId',
+     *      layout
+     * };
+     * const req = {
+     *      pageId: 'myPageId',
+     *      page
+     * };
+     * await workspacePlatform.Storage.updatePage(req);
+     * ```
      * @param req the update saved page request.
      */
     updatePage(req: UpdateSavedPageRequest): Promise<void>;
     /**
      * Delete a page from persistent storage.
+     *
+     * ```ts
+     * import * as WorkspacePlatform from '@openfin/workspace-platform';
+     *
+     * const workspacePlatform = WorkspacePlatform.getCurrentSync();
+     * await workspacePlatform.Storage.deletePage('myPageId');
+     * ```
      * @param id the id of the page to delete.
      */
     deletePage(id: string): Promise<void>;
@@ -283,6 +444,35 @@ export interface WorkspacePlatformStorage {
      * This is a helper function that will call `getPage` to determine if a page is already in storage.
      * If the page is already in storage, it will call `updatePage`.
      * If it does not exist in storage, the function will call `createPage` instead.
+     *
+     * ```ts
+     * import * as WorkspacePlatform from '@openfin/workspace-platform';
+     *
+     * const workspacePlatform = WorkspacePlatform.getCurrentSync();
+     * const layout = {
+     *      content: [
+     *          {
+     *              type: 'stack',
+     *              content: [
+     *                  {
+     *                      type: 'component',
+     *                      componentName: 'view',
+     *                      componentState: {
+     *                          name: 'myViewName',
+     *                          url: 'http://google.com'
+     *                      }
+     *                  }
+     *              ]
+     *           }
+     *      ]
+     * };
+     * const page = {
+     *      title: 'myPageTitle',
+     *      pageId: 'myPageId',
+     *      layout
+     * };
+     * await workspacePlatform.Storage.savePage(page);
+     * ```
      * @param page the page to save.
      */
     savePage(page: Page): Promise<void>;

package/common/src/api/pages/idb.d.ts

@@ -1,4 +1,4 @@
-import type { Page } from '@common/api/pages/shapes';
+import type { Page } from '../../../../common/src/api/pages/shapes';
 export declare const store: import("idb-keyval").UseStore;
 export declare function getPage(id: string): Promise<Page>;
 export declare function getPageList(filter?: string): Promise<Page[]>;

package/common/src/api/pages/index.d.ts

@@ -1,4 +1,4 @@
-import { LayoutExtended } from '@common/utils/layout';
+import { LayoutExtended } from '../../../../common/src/utils/layout';
 import type { AttachedPage, Page, PageLayout, PageWithUpdatableRuntimeAttribs } from './shapes';
 export declare function getLegacyPages(): Promise<Page[]>;
 export declare function cleanPage(page: AttachedPage): Page;

package/common/src/api/pages/legacy.d.ts

@@ -1,4 +1,4 @@
-import type { AttachedPage, PageLayout } from '@common/api/pages/shapes';
+import type { AttachedPage, PageLayout } from '../../../../common/src/api/pages/shapes';
 interface Workstack {
     id: string;
     name: string;

package/common/src/utils/theming.d.ts

@@ -1,4 +1,4 @@
-import { CustomPaletteSet } from '@common/api/theming';
+import { CustomPaletteSet } from '../../../common/src/api/theming';
 /**
  * Get hue from a CSS color
  *

package/package.json

@@ -1 +1 @@
-{"name":"@openfin/workspace-platform","description":"An API for creating your own Workspace platform.","contributors":[],"version":"4.15.0","main":"index.ts","scripts":{"deploy":"npm run deploy:npm && npm run deploy:docs","deploy:npm":"cd out && npm publish","deploy:docs":"aws s3 cp --recursive ./docs/ s3://cdn.openfin.co/workspace/api/platform/docs/","deploy:next":"npm run deploy:next:npm && npm run deploy:next:docs","deploy:next:npm":"cd out && npm publish --tag next","deploy:next:docs":"aws s3 cp --recursive ./docs/ s3://cdn.openfin.co/workspace/api/platform/docs/next/","cp:readme":"copyfiles README.md out","cp:package":"node ../common/scripts/cp-package.js","cp:next:package":"node ../common/scripts/cp-package-next.js","create:rootIndex":"node ../common/scripts/cp-root-index.js","package":"npm run cp:readme && npm run cp:package && npm run create:rootIndex","package:next":"npm run cp:readme && npm run cp:next:package && npm run create:rootIndex","clean":"rimraf ./out && rimraf ./docs","build:common":"cross-env ENV=prod webpack --mode=production --config ./webpack.common.config.js","build":"npm run clean && npm run build:common && npm run build:docs","build:docs":"typedoc --tsconfig ./tsconfig.json --readme none --disableSources ./src/index.ts","test":"jest --watch --colors","test:ci":"jest"},"keywords":["client","api","workspace","platform"],"license":"MIT"}
+{"name":"@openfin/workspace-platform","description":"An API for creating your own Workspace platform.","contributors":[],"version":"4.19.0","main":"index.ts","scripts":{"deploy":"npm run deploy:npm && npm run deploy:docs","deploy:npm":"cd out && npm publish","deploy:docs":"aws s3 cp --recursive ./docs/ s3://cdn.openfin.co/workspace/api/platform/docs/","deploy:next":"npm run deploy:next:npm && npm run deploy:next:docs","deploy:next:npm":"cd out && npm publish --tag next","deploy:next:docs":"aws s3 cp --recursive ./docs/ s3://cdn.openfin.co/workspace/api/platform/docs/next/","cp:readme":"copyfiles README.md out","cp:package":"node ../common/scripts/cp-package.js","cp:next:package":"node ../common/scripts/cp-package-next.js","create:rootIndex":"node ../common/scripts/cp-root-index.js","package":"npm run cp:readme && npm run cp:package && npm run create:rootIndex","package:next":"npm run cp:readme && npm run cp:next:package && npm run create:rootIndex","clean":"rimraf ./out && rimraf ./docs","build:common":"cross-env ENV=prod webpack --mode=production --config ./webpack.common.config.js","build":"npm run clean && npm run build:common && npm run build:docs","build:docs":"typedoc --tsconfig ./tsconfig.json --readme none --disableSources ./src/index.ts","test":"jest --watch --colors","test:ci":"jest"},"keywords":["client","api","workspace","platform"],"license":"MIT"}

package/search-api/src/client/internal.d.ts

@@ -1,4 +1,4 @@
-import { ChannelClient } from '@search/fin/shapes';
+import { ChannelClient } from '../../../search-api/src/fin/shapes';
 import type { Action, SearchProvider, SearchProviderResponseGeneratorExtended, SearchRequest, SearchResult } from '../shapes';
 /**
  * Register a remote search provider.