@openfin/core 32.75.8 → 32.75.9

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@openfin/core",
-    "version": "32.75.8",
+    "version": "32.75.9",
     "license": "SEE LICENSE IN LICENSE.MD",
     "main": "./src/mock.js",
     "types": "./src/mock.d.ts",

package/src/OpenFin.d.ts

@@ -1923,6 +1923,7 @@ export type Margins = {
  * Options for printing a webpage in OpenFin.
  */
 export type PrintOptions = {
+    content?: 'self';
     /**
      * Disables prompting the user for print settings.
      */
@@ -1966,7 +1967,7 @@ export type PrintOptions = {
     /**
      * Page range to print.
      */
-    pageRanges?: Record<'from' | 'to', number>;
+    pageRanges?: Array<Record<'from' | 'to', number>>;
     /**
      * Duplex mode of the printed webpage.
      */
@@ -1976,6 +1977,14 @@ export type PrintOptions = {
      */
     dpi?: Dpi;
 };
+export type ScreenshotPrintOptions = {
+    content: 'screenshot';
+};
+export type WindowViewsPrintOptions = {
+    content: 'views';
+    includeSelf?: boolean;
+};
+export type WindowPrintOptions = PrintOptions | ScreenshotPrintOptions | WindowViewsPrintOptions;
 /**
  * A request to write data to the clipboard.
  */

package/src/api/webcontents/main.d.ts

@@ -3,6 +3,7 @@ import { EmitterBase } from '../base';
 import { Transport } from '../../transport/transport';
 import { BaseEvent } from '../events/base';
 export declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
+    identity: OpenFin.Identity;
     entityType: string;
     constructor(wire: Transport, identity: OpenFin.Identity, entityType: string);
     capturePage(options?: OpenFin.CapturePageOptions): Promise<string>;

package/src/api/webcontents/main.js

@@ -5,6 +5,7 @@ const base_1 = require("../base");
 class WebContents extends base_1.EmitterBase {
     constructor(wire, identity, entityType) {
         super(wire, entityType, identity.uuid, identity.name);
+        this.identity = identity;
         this.entityType = entityType;
     }
     capturePage(options) {
@@ -41,7 +42,7 @@ class WebContents extends base_1.EmitterBase {
         })
             .then(() => undefined);
     }
-    print(options) {
+    print(options = {}) {
         return this.wire.sendAction('print', { ...this.identity, options }).then(() => undefined);
     }
     findInPage(searchTerm, options) {

package/src/api/window/Instance.d.ts

@@ -1074,4 +1074,11 @@ export declare class _Window extends WebContents<OpenFin.WindowEvent> {
      * @tutorial Window.dispatchPopupResult
      */
     dispatchPopupResult(data: any): Promise<void>;
+    /**
+     * Prints the contents of the window.
+     *
+     * @param options Configuration for the print task.
+     * @tutorial Window.print
+     */
+    print(options?: OpenFin.WindowPrintOptions): Promise<void>;
 }

package/src/api/window/Instance.js

@@ -1320,5 +1320,24 @@ class _Window extends main_1.WebContents {
         });
         await this.wire.sendAction('dispatch-popup-result', { data, ...this.identity });
     }
+    /**
+     * Prints the contents of the window.
+     *
+     * @param options Configuration for the print task.
+     * @tutorial Window.print
+     */
+    async print(options = { content: 'self' }) {
+        switch (options.content) {
+            case undefined:
+            case 'self':
+                return super.print(options);
+            case 'screenshot':
+                return this.wire.sendAction('print-screenshot', this.identity).then(() => undefined);
+            case 'views':
+                return this.wire.sendAction('print-views', { ...this.identity, options }).then(() => undefined);
+            default:
+                return undefined;
+        }
+    }
 }
 exports._Window = _Window;

package/src/shapes/protocol.d.ts

@@ -37,6 +37,22 @@ export interface ProtocolMap extends ProtocolMapBase {
     }>;
     'trigger-before-unload': IdentityCall<{}, boolean>;
     'window-get-views': IdentityCall<{}, OpenFin.Identity[]>;
+    'print': {
+        request: OpenFin.Identity & {
+            options: OpenFin.PrintOptions;
+        };
+        response: void;
+    };
+    'print-screenshot': {
+        request: OpenFin.Identity;
+        response: void;
+    };
+    'print-views': {
+        request: OpenFin.Identity & {
+            options: OpenFin.WindowViewsPrintOptions;
+        };
+        response: void;
+    };
     'launch-manifest': {
         request: {
             manifestUrl: string;