@openfin/workspace-platform 4.9.0 → 4.13.0

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

@@ -124,14 +124,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 +309,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.9.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.13.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"}