@openfin/workspace-platform 4.10.0 → 4.14.0

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/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

@@ -7,7 +7,7 @@ export declare const getBrowserApi: (identity: OpenFin.ApplicationIdentity) => {
         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>;

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

@@ -77,15 +77,39 @@ export interface BrowserWindowModule {
     openfinWindow: OpenFin.Window;
     /**
      * Get a page that is attached to the browser window.
+     *
+     * ```ts
+     * import * as WorkspacePlatform from '@client-platform/index';
+     *
+     * const workspacePlatform = WorkspacePlatform.getCurrentSync();
+     * const windows = await workspacePlatform.Browser.getAllWindows();
+     * const page = await windows[0].getPage('MyPageId');
+     * ```
      * @param id the id of the page to get.
      */
     getPage(id: string): Promise<AttachedPage>;
     /**
      * Return all the pages that are attached to a browser window.
+     *
+     * ```ts
+     * import * as WorkspacePlatform from '@client-platform/index';
+     *
+     * const workspacePlatform = WorkspacePlatform.getCurrentSync();
+     * const windows = await workspacePlatform.Browser.getAllWindows();
+     * const pages = await windows[0].getPages();
+     * ```
      */
     getPages(): Promise<AttachedPage[]>;
     /**
      * Set the active page for the browser window.
+     *
+     * ```ts
+     * import * as WorkspacePlatform from '@client-platform/index';
+     *
+     * const workspacePlatform = WorkspacePlatform.getCurrentSync();
+     * const windows = await workspacePlatform.Browser.getAllWindows();
+     * await windows[0].setActivePage('MyPageId');
+     * ```
      * @param id the id of the attached page to set as active.
      */
     setActivePage(id: string): Promise<void>;
@@ -93,6 +117,35 @@ export interface BrowserWindowModule {
      * Attach a page to a browser window.
      * 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';
+     *
+     * 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 windows = await workspacePlatform.Browser.getAllWindows();
+     * await windows[0].addPage(page);
+     * ```
      * @param page the attach page to a browser window.
      */
     addPage(page: PageWithUpdatableRuntimeAttribs): Promise<void>;
@@ -124,14 +177,65 @@ export interface BrowserWindowFactory {
     wrapSync: (identity: OpenFin.Identity) => BrowserWindowModule;
     /**
      * Get a list of all pages that are attached to any running browser window.
+     *
+     * ```ts
+     * import * as WorkspacePlatform from '@client-platform/index';
+     *
+     * const workspacePlatform = WorkspacePlatform.getCurrentSync();
+     * const attachedPages = await workspacePlatform.Browser.getAllAttachedPages();
+     * ```
      */
     getAllAttachedPages(): Promise<AttachedPage[]>;
     /**
      *  Get all the Browser Windows that are running in the Workspace Platform.
+     *
+     * ```ts
+     * import * as WorkspacePlatform from '@client-platform/index';
+     *
+     * const workspacePlatform = WorkspacePlatform.getCurrentSync();
+     * const windows = await workspacePlatform.Browser.getAllWindows();
+     * ```
      */
     getAllWindows(): Promise<BrowserWindowModule[]>;
     /**
      * Create a new browser window.
+     *
+     * ```ts
+     * import * as WorkspacePlatform from '@client-platform/index';
+     *
+     * 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 options: BrowserCreateWindowRequest = {
+     *      workspacePlatform {
+     *          pages: [page],
+     *          title: 'My Window Title',
+     *          favicon: 'https://google.com/favicon.ico'
+     *      }
+     * };
+     * const window = await workspacePlatform.Browser.createWindow(options);
+     * ```
+     *
      * @param options the browser window creation options
      */
     createWindow(options: BrowserCreateWindowRequest): Promise<BrowserWindowModule>;
@@ -258,8 +362,6 @@ export interface WorkspacePlatformProvider extends OpenFin.PlatformProvider {
 export interface WorkspacePlatformInitConfig {
     /** Config for overriding browser options and behavior. */
     browser?: BrowserInitConfig;
-    /** License key for Workspace Platform. */
-    licenseKey: string;
     /** Custom Themes object */
     theme?: CustomThemes;
 }

package/package.json

@@ -1 +1 @@
-{"name":"@openfin/workspace-platform","description":"An API for creating your own Workspace platform.","contributors":[],"version":"4.10.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.14.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"}