@adobe/exc-app 0.2.39 → 0.2.42

package/coverage/lcov-report/sorter.js

@@ -0,0 +1,170 @@
+/* eslint-disable */
+var addSorting = (function() {
+    'use strict';
+    var cols,
+        currentSort = {
+            index: 0,
+            desc: false
+        };
+
+    // returns the summary table element
+    function getTable() {
+        return document.querySelector('.coverage-summary');
+    }
+    // returns the thead element of the summary table
+    function getTableHeader() {
+        return getTable().querySelector('thead tr');
+    }
+    // returns the tbody element of the summary table
+    function getTableBody() {
+        return getTable().querySelector('tbody');
+    }
+    // returns the th element for nth column
+    function getNthColumn(n) {
+        return getTableHeader().querySelectorAll('th')[n];
+    }
+
+    // loads all columns
+    function loadColumns() {
+        var colNodes = getTableHeader().querySelectorAll('th'),
+            colNode,
+            cols = [],
+            col,
+            i;
+
+        for (i = 0; i < colNodes.length; i += 1) {
+            colNode = colNodes[i];
+            col = {
+                key: colNode.getAttribute('data-col'),
+                sortable: !colNode.getAttribute('data-nosort'),
+                type: colNode.getAttribute('data-type') || 'string'
+            };
+            cols.push(col);
+            if (col.sortable) {
+                col.defaultDescSort = col.type === 'number';
+                colNode.innerHTML =
+                    colNode.innerHTML + '<span class="sorter"></span>';
+            }
+        }
+        return cols;
+    }
+    // attaches a data attribute to every tr element with an object
+    // of data values keyed by column name
+    function loadRowData(tableRow) {
+        var tableCols = tableRow.querySelectorAll('td'),
+            colNode,
+            col,
+            data = {},
+            i,
+            val;
+        for (i = 0; i < tableCols.length; i += 1) {
+            colNode = tableCols[i];
+            col = cols[i];
+            val = colNode.getAttribute('data-value');
+            if (col.type === 'number') {
+                val = Number(val);
+            }
+            data[col.key] = val;
+        }
+        return data;
+    }
+    // loads all row data
+    function loadData() {
+        var rows = getTableBody().querySelectorAll('tr'),
+            i;
+
+        for (i = 0; i < rows.length; i += 1) {
+            rows[i].data = loadRowData(rows[i]);
+        }
+    }
+    // sorts the table using the data for the ith column
+    function sortByIndex(index, desc) {
+        var key = cols[index].key,
+            sorter = function(a, b) {
+                a = a.data[key];
+                b = b.data[key];
+                return a < b ? -1 : a > b ? 1 : 0;
+            },
+            finalSorter = sorter,
+            tableBody = document.querySelector('.coverage-summary tbody'),
+            rowNodes = tableBody.querySelectorAll('tr'),
+            rows = [],
+            i;
+
+        if (desc) {
+            finalSorter = function(a, b) {
+                return -1 * sorter(a, b);
+            };
+        }
+
+        for (i = 0; i < rowNodes.length; i += 1) {
+            rows.push(rowNodes[i]);
+            tableBody.removeChild(rowNodes[i]);
+        }
+
+        rows.sort(finalSorter);
+
+        for (i = 0; i < rows.length; i += 1) {
+            tableBody.appendChild(rows[i]);
+        }
+    }
+    // removes sort indicators for current column being sorted
+    function removeSortIndicators() {
+        var col = getNthColumn(currentSort.index),
+            cls = col.className;
+
+        cls = cls.replace(/ sorted$/, '').replace(/ sorted-desc$/, '');
+        col.className = cls;
+    }
+    // adds sort indicators for current column being sorted
+    function addSortIndicators() {
+        getNthColumn(currentSort.index).className += currentSort.desc
+            ? ' sorted-desc'
+            : ' sorted';
+    }
+    // adds event listeners for all sorter widgets
+    function enableUI() {
+        var i,
+            el,
+            ithSorter = function ithSorter(i) {
+                var col = cols[i];
+
+                return function() {
+                    var desc = col.defaultDescSort;
+
+                    if (currentSort.index === i) {
+                        desc = !currentSort.desc;
+                    }
+                    sortByIndex(i, desc);
+                    removeSortIndicators();
+                    currentSort.index = i;
+                    currentSort.desc = desc;
+                    addSortIndicators();
+                };
+            };
+        for (i = 0; i < cols.length; i += 1) {
+            if (cols[i].sortable) {
+                // add the click event handler on the th so users
+                // dont have to click on those tiny arrows
+                el = getNthColumn(i).querySelector('.sorter').parentElement;
+                if (el.addEventListener) {
+                    el.addEventListener('click', ithSorter(i));
+                } else {
+                    el.attachEvent('onclick', ithSorter(i));
+                }
+            }
+        }
+    }
+    // adds sorting functionality to the UI
+    return function() {
+        if (!getTable()) {
+            return;
+        }
+        cols = loadColumns();
+        loadData();
+        addSortIndicators();
+        enableUI();
+    };
+})();
+
+window.addEventListener('load', addSorting);

package/index.d.ts

@@ -9,6 +9,7 @@
  * written permission of Adobe.
  **************************************************************************/
 import Runtime from './src/Runtime';
+export type { RuntimeConfiguration } from './RuntimeConfiguration';
 /**
  * Get the runtime object which contains all unified-shell APIs.
  *

package/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;4EAS4E;;;;;;;;;;;;;;;;;;;;;;AAE5E;;;;;GAKG;AAEH,uDAA6C;AAG7C;;;;;;;;;;;;;;;;;GAiBG;AACH,SAAwB,OAAO;IAC7B,0DAA0D;IAC1D,OAAO,gBAAO,CAAC,SAAS,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,yCAAyC;AACpF,CAAC;AAHD,0BAGC;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,SAAgB,IAAI,CAAC,SAAqC;IACxD,MAAM,QAAQ,GAAG,GAAS,EAAE;QAC1B,SAAS,CAAC,OAAO,EAAE,CAAC,CAAC;IACvB,CAAC,CAAC;IACF,IAAI,gBAAM,CAAC,oBAAoB,CAAC,EAAE;QAChC,QAAQ,EAAE,CAAC;KACZ;SAAM;QACL,gBAAM,CAAC,YAAY,GAAG,QAAQ,CAAC;KAChC;AACH,CAAC;AATD,oBASC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;4EAS4E;;;;;;;;;;;;;;;;;;;;;;AAE5E;;;;;GAKG;AACH,uDAA6C;AAI7C;;;;;;;;;;;;;;;;;GAiBG;AACH,SAAwB,OAAO;IAC7B,0DAA0D;IAC1D,OAAO,gBAAO,CAAC,SAAS,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,yCAAyC;AACpF,CAAC;AAHD,0BAGC;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,SAAgB,IAAI,CAAC,SAAqC;IACxD,MAAM,QAAQ,GAAG,GAAS,EAAE;QAC1B,SAAS,CAAC,OAAO,EAAE,CAAC,CAAC;IACvB,CAAC,CAAC;IACF,IAAI,gBAAM,CAAC,oBAAoB,CAAC,EAAE;QAChC,QAAQ,EAAE,CAAC;KACZ;SAAM;QACL,gBAAM,CAAC,YAAY,GAAG,QAAQ,CAAC;KAChC;AACH,CAAC;AATD,oBASC"}

package/index.ts

@@ -15,9 +15,9 @@
  * @packageDocumentation
  * @preferred
  */
-
 import Global, {getImpl} from './src/Global';
 import Runtime from './src/Runtime';
+export type {RuntimeConfiguration} from './RuntimeConfiguration';
 
 /**
  * Get the runtime object which contains all unified-shell APIs.

package/network.d.ts

@@ -8,6 +8,51 @@
  * then your use, modification, or distribution of it requires the prior
  * written permission of Adobe.
  **************************************************************************/
+/**
+ * APIs that simplify code to make authenticated network requests for resources, execute GraphQL
+ * queries, etc..
+ *
+ * ***Import:***
+ *
+ * ```typescript
+ * import {fetch, query} from '@adobe/exc-app/network';
+ * ```
+ *
+ * ***Default export:***
+ *
+ * [NetworkApi](../interfaces/network.networkapi.md)
+ *
+ * ***Usage:***
+ *
+ * ```typescript
+ * import {fetch, query} from '@adobe/exc-app/network';
+ *
+ * // Performs a window.fetch call with Authorization and x-api-key headers set
+ * const fetchResponse = await fetch('https://localhost', {auth: 'Header', method: 'GET'});
+ *
+ * // Executes a query for resources to the ExC GraphQL service
+ * const queryResponse = await query({
+ *   data: {
+ *     query: `
+ *       query userBehanceQuery($userId: String!, $apiKey: String!) {
+ *         userBehance(userId: $userId, apiKey: $apiKey) {
+ *           images
+ *         }
+ *       }`,
+ *     variables: {
+ *       apiKey: 'test-app',
+ *       userId: '123@AdobeID'
+ *     }
+ *   },
+ *   operationName: 'BehanceAvatar'
+ * });
+ *
+ * ```
+ * @packageDocumentation
+ * @module network
+ */
+import type { ApolloClient, ApolloLink, InMemoryCache, InMemoryCacheConfig } from '@apollo/client';
+import type { gql } from 'graphql-tag';
 /**
  * Default status codes which imply a transient error and can be retried.
  */
@@ -299,6 +344,11 @@ export declare enum FetchScope {
  * `{method: 'GET'}`
  */
 export declare type FetchInit = RequestInit & FetchOptions;
+export interface ApolloClientOptions {
+    connectToDevTools?: boolean;
+    inputApolloLink?: ApolloLink;
+    cacheOptions?: InMemoryCacheConfig;
+}
 export interface NetworkApi {
     /**
      * @deprecated
@@ -365,6 +415,31 @@ export interface NetworkApi {
      * @returns The promise for the response to the query operation.
      */
     query(request: QueryRequest): Promise<Response>;
+    /**
+     * Provides an interface for querying resources via GraphqQL using ApolloClient
+     * ***Example***
+     * ```typescript
+     *  const apolloClientModule = await getApolloClient();
+     *  const apolloClient = apolloClientModule.apolloClient;
+     *  const gql = apolloClientModule.gql;
+     *  const result = await apolloClient.query({
+     *    query: gql`query  user {
+     *      id
+     *      name
+     *    }`,
+     *    variables : {}
+     *  });
+     *  console.log(result.data);
+     * ```
+     * @param options Configuration to create ApolloClient instance
+     *
+     * @returns GraphQL query response
+     *
+     */
+    getApolloClient(options?: ApolloClientOptions): Promise<{
+        apolloClient: ApolloClient<InMemoryCache>;
+        gql: typeof gql;
+    }>;
 }
 /**
  * Provides an interface for fetching resources powered by the global 'fetch' API.
@@ -425,4 +500,34 @@ export declare function fetch(input: RequestInfo, init?: FetchInit): Promise<Res
  * @returns The promise for the response to the query operation.
  */
 export declare function query(input: QueryRequest): Promise<Response>;
+/**
+ * Provides an interface for querying resources via GraphqQL using ApolloClient
+ * ***Example***
+ * ```typescript
+ *  const apolloClientModule = await getApolloClient();
+ *  const apolloClient = apolloClientModule.apolloClient;
+ *  const gql = apolloClientModule.gql;
+ *  const result = await apolloClient.query({
+ *    query: gql`query  user {
+ *      id
+ *      name
+ *    }`,
+ *    variables : {}
+ *  });
+ *  console.log(result.data);
+ * ```
+ * @param options Configuration to create ApolloClient instance
+ * @returns GraphQL query response
+ *
+ */
+export declare function getApolloClient(options?: ApolloClientOptions): Promise<{
+    apolloClient: ApolloClient<InMemoryCache>;
+    gql: typeof gql;
+}>;
+/**
+ * @ignore
+ */
+export declare class Internal {
+    static configure(config: Configuration): void;
+}
 export {};

package/network.js

@@ -10,50 +10,7 @@
  * written permission of Adobe.
  **************************************************************************/
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.query = exports.fetch = exports.FetchScope = exports.ROUTING = exports.DEFAULT_STATUS_CODES_TO_RETRY = void 0;
-/**
- * APIs that simplify code to make authenticated network requests for resources, execute GraphQL
- * queries, etc..
- *
- * ***Import:***
- *
- * ```typescript
- * import {fetch, query} from '@adobe/exc-app/network';
- * ```
- *
- * ***Default export:***
- *
- * [NetworkApi](../interfaces/network.networkapi.md)
- *
- * ***Usage:***
- *
- * ```typescript
- * import {fetch, query} from '@adobe/exc-app/network';
- *
- * // Performs a window.fetch call with Authorization and x-api-key headers set
- * const fetchResponse = await fetch('https://localhost', {auth: 'Header', method: 'GET'});
- *
- * // Executes a query for resources to the ExC GraphQL service
- * const queryResponse = await query({
- *   data: {
- *     query: `
- *       query userBehanceQuery($userId: String!, $apiKey: String!) {
- *         userBehance(userId: $userId, apiKey: $apiKey) {
- *           images
- *         }
- *       }`,
- *     variables: {
- *       apiKey: 'test-app',
- *       userId: '123@AdobeID'
- *     }
- *   },
- *   operationName: 'BehanceAvatar'
- * });
- *
- * ```
- * @packageDocumentation
- * @module network
- */
+exports.Internal = exports.getApolloClient = exports.query = exports.fetch = exports.FetchScope = exports.ROUTING = exports.DEFAULT_STATUS_CODES_TO_RETRY = void 0;
 const Global_1 = require("./src/Global");
 /**
  * Default status codes which imply a transient error and can be retried.
@@ -170,4 +127,37 @@ function query(input) {
     return Global_1.getImpl('network').query(input);
 }
 exports.query = query;
+/**
+ * Provides an interface for querying resources via GraphqQL using ApolloClient
+ * ***Example***
+ * ```typescript
+ *  const apolloClientModule = await getApolloClient();
+ *  const apolloClient = apolloClientModule.apolloClient;
+ *  const gql = apolloClientModule.gql;
+ *  const result = await apolloClient.query({
+ *    query: gql`query  user {
+ *      id
+ *      name
+ *    }`,
+ *    variables : {}
+ *  });
+ *  console.log(result.data);
+ * ```
+ * @param options Configuration to create ApolloClient instance
+ * @returns GraphQL query response
+ *
+ */
+function getApolloClient(options) {
+    return Global_1.getImpl('network').getApolloClient(options);
+}
+exports.getApolloClient = getApolloClient;
+/**
+ * @ignore
+ */
+class Internal {
+    static configure(config) {
+        return Global_1.getImpl('network').configure(config);
+    }
+}
+exports.Internal = Internal;
 //# sourceMappingURL=network.js.map

package/network.js.map

@@ -1 +1 @@
-{"version":3,"file":"network.js","sourceRoot":"","sources":["network.ts"],"names":[],"mappings":";AAAA;;;;;;;;;4EAS4E;;;AAE5E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0CG;AAEH,yCAAqC;AAErC;;GAEG;AACU,QAAA,6BAA6B,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;AAsKlE,IAAY,OAEX;AAFD,WAAY,OAAO;IACjB,+DAAiB,CAAA;AACnB,CAAC,EAFW,OAAO,GAAP,eAAO,KAAP,eAAO,QAElB;AA0ED;;GAEG;AACH,IAAY,UAqCX;AArCD,WAAY,UAAU;IACpB;;;OAGG;IACH,2BAAW,CAAA;IACX;;;;OAIG;IACH,2BAAW,CAAA;IACX;;;;;OAKG;IACH,yBAAS,CAAA;IACT;;;;;;OAMG;IACH,iCAAiB,CAAA;IACjB;;;;;;;;OAQG;IACH,2CAA2B,CAAA;AAC7B,CAAC,EArCW,UAAU,GAAV,kBAAU,KAAV,kBAAU,QAqCrB;AAoFD;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,SAAgB,KAAK,CAAC,KAAkB,EAAE,IAAgB;IACxD,OAAO,gBAAO,CAAC,SAAS,CAAC,CAAC,KAAK,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;AAC/C,CAAC;AAFD,sBAEC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,SAAgB,KAAK,CAAC,KAAmB;IACvC,OAAO,gBAAO,CAAC,SAAS,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;AACzC,CAAC;AAFD,sBAEC"}
+{"version":3,"file":"network.js","sourceRoot":"","sources":["network.ts"],"names":[],"mappings":";AAAA;;;;;;;;;4EAS4E;;;AA+C5E,yCAAqC;AAGrC;;GAEG;AACU,QAAA,6BAA6B,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;AAsKlE,IAAY,OAEX;AAFD,WAAY,OAAO;IACjB,+DAAiB,CAAA;AACnB,CAAC,EAFW,OAAO,GAAP,eAAO,KAAP,eAAO,QAElB;AA0ED;;GAEG;AACH,IAAY,UAqCX;AArCD,WAAY,UAAU;IACpB;;;OAGG;IACH,2BAAW,CAAA;IACX;;;;OAIG;IACH,2BAAW,CAAA;IACX;;;;;OAKG;IACH,yBAAS,CAAA;IACT;;;;;;OAMG;IACH,iCAAiB,CAAA;IACjB;;;;;;;;OAQG;IACH,2CAA2B,CAAA;AAC7B,CAAC,EArCW,UAAU,GAAV,kBAAU,KAAV,kBAAU,QAqCrB;AAmHD;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,SAAgB,KAAK,CAAC,KAAkB,EAAE,IAAgB;IACxD,OAAO,gBAAO,CAAC,SAAS,CAAC,CAAC,KAAK,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;AAC/C,CAAC;AAFD,sBAEC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,SAAgB,KAAK,CAAC,KAAmB;IACvC,OAAO,gBAAO,CAAC,SAAS,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;AACzC,CAAC;AAFD,sBAEC;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,SAAgB,eAAe,CAC7B,OAA6B;IAK7B,OAAO,gBAAO,CAAC,SAAS,CAAC,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;AACrD,CAAC;AAPD,0CAOC;AAED;;GAEG;AACH,MAAa,QAAQ;IACZ,MAAM,CAAC,SAAS,CAAC,MAAqB;QAC3C,OAAO,gBAAO,CAAC,SAAS,CAAC,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;IAC9C,CAAC;CACF;AAJD,4BAIC"}

package/network.ts

@@ -53,7 +53,9 @@
  * @module network
  */
 
+import type {ApolloClient, ApolloLink, InMemoryCache, InMemoryCacheConfig} from '@apollo/client';
 import {getImpl} from './src/Global';
+import type {gql} from 'graphql-tag';
 
 /**
  * Default status codes which imply a transient error and can be retried.
@@ -354,6 +356,12 @@ export enum FetchScope {
  */
 export type FetchInit = RequestInit & FetchOptions;
 
+export interface ApolloClientOptions {
+  connectToDevTools?: boolean;
+  inputApolloLink?: ApolloLink;
+  cacheOptions?: InMemoryCacheConfig;
+}
+
 export interface NetworkApi {
   /**
    * @deprecated
@@ -422,6 +430,31 @@ export interface NetworkApi {
    */
   query(request: QueryRequest): Promise<Response>;
 
+  /**
+   * Provides an interface for querying resources via GraphqQL using ApolloClient
+   * ***Example***
+   * ```typescript
+   *  const apolloClientModule = await getApolloClient();
+   *  const apolloClient = apolloClientModule.apolloClient;
+   *  const gql = apolloClientModule.gql;
+   *  const result = await apolloClient.query({
+   *    query: gql`query  user {
+   *      id
+   *      name
+   *    }`,
+   *    variables : {}
+   *  });
+   *  console.log(result.data);
+   * ```
+   * @param options Configuration to create ApolloClient instance
+   *
+   * @returns GraphQL query response
+   *
+   */
+  getApolloClient(options?:ApolloClientOptions): Promise<{
+    apolloClient: ApolloClient<InMemoryCache>;
+    gql: typeof gql;
+  }>;
 }
 
 /**
@@ -488,3 +521,41 @@ export function fetch(input: RequestInfo, init?: FetchInit): Promise<Response> {
 export function query(input: QueryRequest): Promise<Response> {
   return getImpl('network').query(input);
 }
+
+/**
+ * Provides an interface for querying resources via GraphqQL using ApolloClient
+ * ***Example***
+ * ```typescript
+ *  const apolloClientModule = await getApolloClient();
+ *  const apolloClient = apolloClientModule.apolloClient;
+ *  const gql = apolloClientModule.gql;
+ *  const result = await apolloClient.query({
+ *    query: gql`query  user {
+ *      id
+ *      name
+ *    }`,
+ *    variables : {}
+ *  });
+ *  console.log(result.data);
+ * ```
+ * @param options Configuration to create ApolloClient instance
+ * @returns GraphQL query response
+ *
+ */
+export function getApolloClient(
+  options?: ApolloClientOptions
+): Promise<{
+    apolloClient: ApolloClient<InMemoryCache>;
+    gql: typeof gql;
+  }> {
+  return getImpl('network').getApolloClient(options);
+}
+
+/**
+ * @ignore
+ */
+export class Internal {
+  public static configure(config: Configuration): void {
+    return getImpl('network').configure(config);
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/exc-app",
-  "version": "0.2.39",
+  "version": "0.2.42",
   "main": "index.js",
   "source": "index.ts",
   "scripts": {
@@ -25,22 +25,26 @@
   "publishConfig": {
     "registry": "https://registry.npmjs.com/"
   },
+  "dependencies": {
+    "@apollo/client": "3.4.11",
+    "graphql-tag": "2.12.5"
+  },
   "devDependencies": {
-    "cross-env": "^7.0.3",
-    "enzyme": "^3.8.0",
-    "eslint": "^7.19.0",
-    "eslint-plugin-header": "^3.1.0",
-    "eslint-plugin-jsdoc": "^30.7.8",
-    "eslint-plugin-prettier": "^3.2.0",
-    "eslint-plugin-rulesdir": "^0.1.0",
-    "glob": "^7.1.6",
-    "jest": "^26.6.3",
-    "jest-dev-server": "^4.4.0",
-    "jest-localstorage-mock": "^2.4.6",
-    "jest-when": "^3.2.0",
-    "ts-jest": "^26.5.1",
-    "typedoc": "^0.19.2",
-    "typedoc-plugin-external-module-name": "^4.0.3",
-    "typedoc-plugin-markdown": "^3.0.11"
+    "cross-env": "7.0.3",
+    "enzyme": "3.11.0",
+    "eslint": "7.19.0",
+    "eslint-plugin-header": "3.1.1",
+    "eslint-plugin-jsdoc": "30.7.13",
+    "eslint-plugin-prettier": "3.4.1",
+    "eslint-plugin-rulesdir": "0.1.0",
+    "glob": "7.1.7",
+    "jest": "26.6.3",
+    "jest-dev-server": "4.4.0",
+    "jest-localstorage-mock": "2.4.17",
+    "jest-when": "3.3.1",
+    "ts-jest": "26.5.6",
+    "typedoc": "0.19.2",
+    "typedoc-plugin-external-module-name": "4.0.6",
+    "typedoc-plugin-markdown": "3.10.4"
   }
 }

package/page.d.ts

@@ -193,10 +193,37 @@ export interface PageApiProperties {
      */
     unloadPromptMessage: string;
 }
+export interface Callback {
+    (value?: any): void;
+}
 /**
  * Defines page-level APIs available to solutions.
  */
 export interface PageApi extends PageApiProperties {
+    /**
+     * A function that listens and handles the afterPrint event.
+     *
+     * ```typescript
+     * ***Example:***
+     * page.afterPrintHandler = function () {
+     *   // Revert temporary CSS changes
+     * };
+     * ````
+     * @param callback The function that results in printing.
+     */
+    afterPrintHandler(callback: Callback): void;
+    /**
+     * A function that listens and handles the beforePrint event.
+     *
+     * ```typescript
+     * ***Example:***
+     * page.beforePrintHandler = function () {
+     *   // Temporary CSS changes, like unsetting height
+     * };
+     * ````
+     * @param callback The function that results in printing.
+     */
+    beforePrintHandler(callback: Callback): void;
     /**
      * Sometimes applications will need to block navigation away from the current page. The most common use case
      * for this is when a user has unsaved changes that would be lost on navigation.
@@ -329,6 +356,21 @@ export interface PageApi extends PageApiProperties {
      * or pathname resolutions specific to the current app.
      */
     openInNewTab(path: string, newApp?: boolean): void;
+    /**
+     * A function to control printing. The callback function should call `window.print()`
+     * at some point. It's important that the callback not be an arrow function if you
+     * want the `window` object to be the iframe contents. Feel free to adjust your
+     * CSS or UI before `window.print()` and reverse those changes afterwards.
+     *
+     * ```typescript
+     * ***Example:***
+     * page.print = function () {
+     *   window.print();
+     * };
+     * ````
+     * @param callback The function that results in printing.
+     */
+    print(callback: Callback): void;
     /**
      * Set the list of selectors presently being used by modalAutoDetect. If set to an empty
      * array, the default selectors used by runtime will be used instead. To stop observing changes

package/page.js

@@ -50,7 +50,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
  */
 const Global_1 = require("./src/Global");
 const page = Global_1.connect('page', [
+    ['afterPrintHandler'],
     ['appContainer'],
+    ['beforePrintHandler'],
     ['blockNavigation', true],
     ['clipboardWrite', true],
     ['done', true],
@@ -63,6 +65,7 @@ const page = Global_1.connect('page', [
     ['notFound', true],
     ['openInNewTab', true],
     ['preventDefaultCombos'],
+    ['print', true],
     ['shellRedirect', true],
     ['setModalQuerySelectors'],
     ['spinner'],

package/page.js.map

@@ -1 +1 @@
-{"version":3,"file":"page.js","sourceRoot":"","sources":["page.ts"],"names":[],"mappings":";AAAA;;;;;;;;;4EAS4E;;AAE5E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AAEH,yCAAqC;AAwXrC,MAAM,IAAI,GAAG,gBAAO,CAAC,MAAM,EAAE;IAC3B,CAAC,cAAc,CAAC;IAChB,CAAC,iBAAiB,EAAE,IAAI,CAAC;IACzB,CAAC,gBAAgB,EAAE,IAAI,CAAC;IACxB,CAAC,MAAM,EAAE,IAAI,CAAC;IACd,CAAC,kBAAkB,EAAE,IAAI,CAAC;IAC1B,CAAC,wBAAwB,CAAC;IAC1B,CAAC,SAAS,CAAC;IACX,CAAC,cAAc,EAAE,IAAI,CAAC;IACtB,CAAC,OAAO,CAAC;IACT,CAAC,iBAAiB,CAAC;IACnB,CAAC,UAAU,EAAE,IAAI,CAAC;IAClB,CAAC,cAAc,EAAE,IAAI,CAAC;IACtB,CAAC,sBAAsB,CAAC;IACxB,CAAC,eAAe,EAAE,IAAI,CAAC;IACvB,CAAC,wBAAwB,CAAC;IAC1B,CAAC,SAAS,CAAC;IACX,CAAC,OAAO,CAAC;IACT,CAAC,qBAAqB,CAAC;CACxB,CAAC,CAAC;AAEH,kBAAe,IAAI,CAAC"}
+{"version":3,"file":"page.js","sourceRoot":"","sources":["page.ts"],"names":[],"mappings":";AAAA;;;;;;;;;4EAS4E;;AAE5E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AAEH,yCAAqC;AAoarC,MAAM,IAAI,GAAG,gBAAO,CAAC,MAAM,EAAE;IAC3B,CAAC,mBAAmB,CAAC;IACrB,CAAC,cAAc,CAAC;IAChB,CAAC,oBAAoB,CAAC;IACtB,CAAC,iBAAiB,EAAE,IAAI,CAAC;IACzB,CAAC,gBAAgB,EAAE,IAAI,CAAC;IACxB,CAAC,MAAM,EAAE,IAAI,CAAC;IACd,CAAC,kBAAkB,EAAE,IAAI,CAAC;IAC1B,CAAC,wBAAwB,CAAC;IAC1B,CAAC,SAAS,CAAC;IACX,CAAC,cAAc,EAAE,IAAI,CAAC;IACtB,CAAC,OAAO,CAAC;IACT,CAAC,iBAAiB,CAAC;IACnB,CAAC,UAAU,EAAE,IAAI,CAAC;IAClB,CAAC,cAAc,EAAE,IAAI,CAAC;IACtB,CAAC,sBAAsB,CAAC;IACxB,CAAC,OAAO,EAAE,IAAI,CAAC;IACf,CAAC,eAAe,EAAE,IAAI,CAAC;IACvB,CAAC,wBAAwB,CAAC;IAC1B,CAAC,SAAS,CAAC;IACX,CAAC,OAAO,CAAC;IACT,CAAC,qBAAqB,CAAC;CACxB,CAAC,CAAC;AAEH,kBAAe,IAAI,CAAC"}