@openfin/workspace-platform 4.23.0 → 4.27.0

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

@@ -581,15 +581,50 @@ export interface WorkspacePlatformInitConfig {
     theme?: CustomThemes;
 }
 /**
- * Callback for overriding a Workspace Platform Provider.
+ * Extend or replace default functionality in order to customize behavior of a Workspace Platform Provider.
+ *
+ * To implement your own handlers for Workspace Platform behavior, extend the provided class and override any methods you'd like to alter.
+ *
+ * ```ts
+ * import * as WorkspacePlatform from '@openfin/workspace-platform';
+ * import { UpdateSavedPageRequest } from '../../client-api-platform/src/shapes';
+ *
+ * const overrideCallback: WorkspacePlatform.BrowserOverrideCallback = async (
+ *    WorkspacePlatformProvider
+ * ) => {
+ *   class Override extends WorkspacePlatformProvider {
+ *       updateSavedPage = async (req: UpdateSavedPageRequest): Promise<void> => {
+ *           console.log(`saving page ${req.page.pageId}`);
+ *           // calling custom function to the save page here
+ *      };
+ *   }
+ *   return new Override();
+ * };
+ *
+ * await WorkspacePlatform.init({
+ *  browser: { overrideCallback },
+ * });
  */
 export declare type BrowserOverrideCallback = OpenFin.OverrideCallback<WorkspacePlatformProvider>;
 /**
  * Configuration for initializing a Browser.
  */
 export interface BrowserInitConfig {
+    /**
+     * Default options for creating a new browser window. Any option not included in WorkspacePlatform.getCurrentSync().Browser.createWindow(options) call will default to the value provided in this field.
+     */
     defaultWindowOptions?: BrowserCreateWindowRequest;
+    /**
+     * 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.
+     */
     defaultViewOptions?: OpenFin.ViewOptions;
+    /**
+     * Override workspace platform behavior
+     */
     overrideCallback?: BrowserOverrideCallback;
+    /**
+     * Override workspace platform interop behavior
+     * https://cdn.openfin.co/docs/javascript/stable/InteropBroker.html
+     */
     interopOverride?: OpenFin.OverrideCallback<InteropBroker, InteropBroker>;
 }

package/package.json

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