@adobe/exc-app 0.2.43-beta2 → 0.2.44

package/docs/modules/network.md

@@ -53,6 +53,7 @@ const queryResponse = await query({
 
 ### Interfaces
 
+* [ApolloClientOptions](../interfaces/network.apolloclientoptions.md)
 * [DefaultMetaData](../interfaces/network.defaultmetadata.md)
 * [FetchOptions](../interfaces/network.fetchoptions.md)
 * [GraphQLQuery](../interfaces/network.graphqlquery.md)
@@ -70,6 +71,7 @@ const queryResponse = await query({
 ### Functions
 
 * [fetch](network.md#fetch)
+* [getApolloClient](network.md#getapolloclient)
 * [query](network.md#query)
 
 ## Type aliases
@@ -99,7 +101,7 @@ Default status codes which imply a transient error and can be retried.
 
 ### fetch
 
-▸ **fetch**(`input`: RequestInfo, `init?`: [FetchInit](network.md#fetchinit)): Promise\<Response>
+▸ **fetch**(`input`: RequestInfo, `init?`: [FetchInit](network.md#fetchinit)): Promise<Response\>
 
 Provides an interface for fetching resources powered by the global 'fetch' API.
 
@@ -128,15 +130,47 @@ Name | Type | Description |
 `input` | RequestInfo | The resource that you wish to fetch. It can either be the URL of the resource you want to fetch or a Request object. |
 `init?` | [FetchInit](network.md#fetchinit) | An object containing any custom settings that you want to apply to the request. |
 
-**Returns:** Promise\<Response>
+**Returns:** Promise<Response\>
 
 The promise for the response to the fetch operation.
 
 ___
 
+### getApolloClient
+
+▸ **getApolloClient**(`options?`: [ApolloClientOptions](../interfaces/network.apolloclientoptions.md)): Promise<{ apolloClient: ApolloClient<InMemoryCache\> ; gql: *typeof* gql  }\>
+
+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);
+```
+
+#### Parameters:
+
+Name | Type | Description |
+------ | ------ | ------ |
+`options?` | [ApolloClientOptions](../interfaces/network.apolloclientoptions.md) | Configuration to create ApolloClient instance |
+
+**Returns:** Promise<{ apolloClient: ApolloClient<InMemoryCache\> ; gql: *typeof* gql  }\>
+
+GraphQL query response
+
+___
+
 ### query
 
-▸ **query**(`input`: [QueryRequest](../interfaces/network.queryrequest.md)): Promise\<Response>
+▸ **query**(`input`: [QueryRequest](../interfaces/network.queryrequest.md)): Promise<Response\>
 
 Provides an interface for querying resources via GraphqQL.
 In order to consume query, please make sure the respective query resolver is
@@ -173,6 +207,6 @@ Name | Type | Description |
 ------ | ------ | ------ |
 `input` | [QueryRequest](../interfaces/network.queryrequest.md) | Query request containing desired GQL Query. |
 
-**Returns:** Promise\<Response>
+**Returns:** Promise<Response\>
 
 The promise for the response to the query operation.

package/docs/modules/page.md

@@ -44,6 +44,7 @@ page.shellRedirect('/target');
 ### Interfaces
 
 * [BlockNavigationOptions](../interfaces/page.blocknavigationoptions.md)
+* [Callback](../interfaces/page.callback.md)
 * [ObjectWithHref](../interfaces/page.objectwithhref.md)
 * [ObjectWithPath](../interfaces/page.objectwithpath.md)
 * [PageApi](../interfaces/page.pageapi.md)

package/docs/modules/pulse.md

@@ -38,5 +38,6 @@ API for sending pulse notifications.
 ### Interfaces
 
 * [PulseApi](../interfaces/pulse.pulseapi.md)
+* [PulseButtonConfig](../interfaces/pulse.pulsebuttonconfig.md)
 * [PulseNotification](../interfaces/pulse.pulsenotification.md)
 * [PulseResponse](../interfaces/pulse.pulseresponse.md)

package/docs/modules/root.md

@@ -0,0 +1,88 @@
+**[@adobe/exc-app](../README.md)**
+
+> [Globals](../README.md) / root
+
+# Module: root
+
+API used to integrate as solution web application with the unified shell of the Adobe Experience
+Cloud.
+
+## Index
+
+### References
+
+* [RuntimeConfiguration](root.md#runtimeconfiguration)
+
+### Interfaces
+
+* [Modules](../interfaces/root.modules.md)
+* [Runtime](../interfaces/root.runtime.md)
+* [RuntimeConfiguration](../interfaces/root.runtimeconfiguration.md)
+
+### Functions
+
+* [init](root.md#init)
+* [runtime](root.md#runtime)
+
+## References
+
+### RuntimeConfiguration
+
+Re-exports: [RuntimeConfiguration](../interfaces/root.runtimeconfiguration.md)
+
+## Functions
+
+### init
+
+▸ **init**(`bootstrap`: (runtime: [Runtime](../interfaces/root.runtime.md)) => void): void
+
+Initializes a solution web application by invoking the bootstrap callback
+once the runtime is ready.
+1. if the module is already defined, start to bootstrap
+2. otherwise define the global callback that will be called when runtime is ready.
+
+***Example:***
+
+```typescript
+import React from 'react';
+import ReactDOM from 'react-dom';
+import runtime, {init} from '@adobe/exc-app';
+
+init(() => {
+  ReactDOM.render(<MainComponent runtime={runtime()} />, document.querySelector('#main'));
+});
+```
+
+#### Parameters:
+
+Name | Type | Description |
+------ | ------ | ------ |
+`bootstrap` | (runtime: [Runtime](../interfaces/root.runtime.md)) => void | Callback used to bootstrap a solution. The runtime object is passed in as a parameter to this callback.  |
+
+**Returns:** void
+
+___
+
+### runtime
+
+▸ **runtime**(): [Runtime](../interfaces/root.runtime.md)
+
+Get the runtime object which contains all unified-shell APIs.
+
+***Example:***
+
+```typescript
+import React from 'react';
+import ReactDOM from 'react-dom';
+import excApp from '@adobe/exc-app';
+
+export class MyComponent extends React.Component {
+  constructor(props) {
+    this.runtime = excApp();
+  }
+}
+```
+
+**Returns:** [Runtime](../interfaces/root.runtime.md)
+
+The runtime object.

package/internal.d.ts

@@ -13,19 +13,42 @@
  * @ignore
  */
 import { Application } from './metrics/Application';
+import EventEmitter from './src/EventEmitter';
 import { Modules } from './src/Global';
 import MetricsConfiguration from './metrics/Configuration';
 import { Configuration as NetworkConfiguration } from './network';
 import User from './metrics/User';
 export type { Modules };
+export interface Poller {
+    activeFrequency: number;
+    hiddenFrequency?: number;
+    name: string;
+    inactiveFrequency: number;
+    immediate: boolean;
+    pollFn: () => Promise<void>;
+}
+export interface PollerHandle {
+    handle: string;
+}
+export interface UserActivityEmitter extends EventEmitter {
+    activityEvents: string[];
+}
+export interface PollingConfiguration {
+    inactivityTimeoutSec?: number;
+    pollWhileInactive?: boolean;
+}
 /**
  * @ignore
  */
 export interface InternalApi {
+    addPoller(poller: Poller): Promise<PollerHandle>;
     clearUser(version?: string): void;
     configureMetrics(config?: MetricsConfiguration): Promise<MetricsConfiguration>;
     configureNetwork(config: NetworkConfiguration): void;
+    configurePolling(config: PollingConfiguration): Promise<void>;
     flush(): Promise<number>;
+    registerActivityEmitter(emitter: UserActivityEmitter): Promise<void>;
+    removePoller(handle: PollerHandle): Promise<void>;
     setApplication(app: Application): void;
     setFilter(filterFunction: <T>(record: T) => Promise<T>): void;
     setUser(user: User, version?: string): void;
@@ -34,9 +57,13 @@ export interface InternalApi {
  * @ignore
  */
 export declare class Internal {
+    static addPoller(poller: Poller): Promise<PollerHandle>;
     static configureMetrics(config?: MetricsConfiguration): Promise<MetricsConfiguration>;
     static configureNetwork(config: NetworkConfiguration): void;
+    static configurePolling(config: PollingConfiguration): Promise<void>;
     static flush(): Promise<number>;
+    static registerActivityEmitter(emitter: UserActivityEmitter): Promise<void>;
+    static removePoller(handle: PollerHandle): Promise<void>;
     static setApplication(app: Application): void;
     static setFilter(filterFunction: <T>(record: T) => Promise<T>): void;
     static setUser(user: User, version?: string): void;

package/internal.js

@@ -16,15 +16,27 @@ const Global_1 = require("./src/Global");
  * @ignore
  */
 class Internal {
+    static addPoller(poller) {
+        return Global_1.getImpl('internal').addPoller(poller);
+    }
     static configureMetrics(config) {
         return Global_1.getImpl('internal').configureMetrics(config);
     }
     static configureNetwork(config) {
         return Global_1.getImpl('internal').configureNetwork(config);
     }
+    static configurePolling(config) {
+        return Global_1.getImpl('internal').configurePolling(config);
+    }
     static flush() {
         return Global_1.getImpl('internal').flush();
     }
+    static registerActivityEmitter(emitter) {
+        return Global_1.getImpl('internal').registerActivityEmitter(emitter);
+    }
+    static removePoller(handle) {
+        return Global_1.getImpl('internal').removePoller(handle);
+    }
     static setApplication(app) {
         return Global_1.getImpl('internal').setApplication(app);
     }

package/internal.js.map

@@ -1 +1 @@
-{"version":3,"file":"internal.js","sourceRoot":"","sources":["internal.ts"],"names":[],"mappings":";AAAA;;;;;;;;;4EAS4E;;;AAO5E,yCAA8C;AAoB9C;;GAEG;AACH,MAAa,QAAQ;IACZ,MAAM,CAAC,gBAAgB,CAAC,MAA6B;QAC1D,OAAO,gBAAO,CAAC,UAAU,CAAC,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC;IACtD,CAAC;IACM,MAAM,CAAC,gBAAgB,CAAC,MAA4B;QACzD,OAAO,gBAAO,CAAC,UAAU,CAAC,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC;IACtD,CAAC;IACM,MAAM,CAAC,KAAK;QACjB,OAAO,gBAAO,CAAC,UAAU,CAAC,CAAC,KAAK,EAAE,CAAC;IACrC,CAAC;IACM,MAAM,CAAC,cAAc,CAAC,GAAgB;QAC3C,OAAO,gBAAO,CAAC,UAAU,CAAC,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC;IACjD,CAAC;IACM,MAAM,CAAC,SAAS,CAAC,cAA4C;QAClE,OAAO,gBAAO,CAAC,UAAU,CAAC,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC;IACvD,CAAC;IACM,MAAM,CAAC,OAAO,CAAC,IAAU,EAAE,OAAgB;QAChD,OAAO,gBAAO,CAAC,UAAU,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IACpD,CAAC;IACM,MAAM,CAAC,SAAS,CAAC,OAAgB;QACtC,OAAO,gBAAO,CAAC,UAAU,CAAC,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;IAChD,CAAC;CACF;AAtBD,4BAsBC"}
+{"version":3,"file":"internal.js","sourceRoot":"","sources":["internal.ts"],"names":[],"mappings":";AAAA;;;;;;;;;4EAS4E;;;AAQ5E,yCAA8C;AA8C9C;;GAEG;AACH,MAAa,QAAQ;IACZ,MAAM,CAAC,SAAS,CAAC,MAAc;QACpC,OAAO,gBAAO,CAAC,UAAU,CAAC,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;IAC/C,CAAC;IACM,MAAM,CAAC,gBAAgB,CAAC,MAA6B;QAC1D,OAAO,gBAAO,CAAC,UAAU,CAAC,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC;IACtD,CAAC;IACM,MAAM,CAAC,gBAAgB,CAAC,MAA4B;QACzD,OAAO,gBAAO,CAAC,UAAU,CAAC,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC;IACtD,CAAC;IACM,MAAM,CAAC,gBAAgB,CAAC,MAA4B;QACzD,OAAO,gBAAO,CAAC,UAAU,CAAC,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC;IACtD,CAAC;IACM,MAAM,CAAC,KAAK;QACjB,OAAO,gBAAO,CAAC,UAAU,CAAC,CAAC,KAAK,EAAE,CAAC;IACrC,CAAC;IACM,MAAM,CAAC,uBAAuB,CAAC,OAA4B;QAChE,OAAO,gBAAO,CAAC,UAAU,CAAC,CAAC,uBAAuB,CAAC,OAAO,CAAC,CAAC;IAC9D,CAAC;IACM,MAAM,CAAC,YAAY,CAAC,MAAoB;QAC7C,OAAO,gBAAO,CAAC,UAAU,CAAC,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;IAClD,CAAC;IACM,MAAM,CAAC,cAAc,CAAC,GAAgB;QAC3C,OAAO,gBAAO,CAAC,UAAU,CAAC,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC;IACjD,CAAC;IACM,MAAM,CAAC,SAAS,CAAC,cAA4C;QAClE,OAAO,gBAAO,CAAC,UAAU,CAAC,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC;IACvD,CAAC;IACM,MAAM,CAAC,OAAO,CAAC,IAAU,EAAE,OAAgB;QAChD,OAAO,gBAAO,CAAC,UAAU,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IACpD,CAAC;IACM,MAAM,CAAC,SAAS,CAAC,OAAgB;QACtC,OAAO,gBAAO,CAAC,UAAU,CAAC,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;IAChD,CAAC;CACF;AAlCD,4BAkCC"}

package/internal.ts

@@ -14,6 +14,7 @@
  * @ignore
  */
 import {Application} from './metrics/Application';
+import EventEmitter from './src/EventEmitter';
 import {getImpl, Modules} from './src/Global';
 import MetricsConfiguration from './metrics/Configuration';
 import {Configuration as NetworkConfiguration} from './network';
@@ -21,14 +22,40 @@ import User from './metrics/User';
 
 export type {Modules};
 
+export interface Poller {
+  activeFrequency: number;
+  hiddenFrequency?: number;
+  name: string;
+  inactiveFrequency: number;
+  immediate: boolean;
+  pollFn: () => Promise<void>;
+}
+
+export interface PollerHandle {
+  handle: string;
+}
+
+export interface UserActivityEmitter extends EventEmitter {
+  activityEvents: string[];
+}
+
+export interface PollingConfiguration {
+  inactivityTimeoutSec?: number;
+  pollWhileInactive?: boolean;
+}
+
 /**
  * @ignore
  */
 export interface InternalApi {
+  addPoller(poller: Poller): Promise<PollerHandle>
   clearUser(version?: string): void
   configureMetrics(config?: MetricsConfiguration): Promise<MetricsConfiguration>;
   configureNetwork(config: NetworkConfiguration): void;
+  configurePolling(config: PollingConfiguration): Promise<void>;
   flush(): Promise<number>;
+  registerActivityEmitter(emitter: UserActivityEmitter): Promise<void>;
+  removePoller(handle: PollerHandle): Promise<void>;
   setApplication(app: Application): void;
   setFilter(filterFunction: <T>(record: T) => Promise<T>): void;
   setUser(user: User, version?: string): void;
@@ -38,15 +65,27 @@ export interface InternalApi {
  * @ignore
  */
 export class Internal {
+  public static addPoller(poller: Poller): Promise<PollerHandle> {
+    return getImpl('internal').addPoller(poller);
+  }
   public static configureMetrics(config?: MetricsConfiguration): Promise<MetricsConfiguration> {
     return getImpl('internal').configureMetrics(config);
   }
   public static configureNetwork(config: NetworkConfiguration): void {
     return getImpl('internal').configureNetwork(config);
   }
+  public static configurePolling(config: PollingConfiguration): Promise<void> {
+    return getImpl('internal').configurePolling(config);
+  }
   public static flush(): Promise<number> {
     return getImpl('internal').flush();
   }
+  public static registerActivityEmitter(emitter: UserActivityEmitter): Promise<void> {
+    return getImpl('internal').registerActivityEmitter(emitter);
+  }
+  public static removePoller(handle: PollerHandle): Promise<void> {
+    return getImpl('internal').removePoller(handle);
+  }
   public static setApplication(app: Application): void {
     return getImpl('internal').setApplication(app);
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/exc-app",
-  "version": "0.2.43-beta2",
+  "version": "0.2.44",
   "main": "index.js",
   "source": "index.ts",
   "scripts": {
@@ -26,7 +26,7 @@
     "registry": "https://registry.npmjs.com/"
   },
   "dependencies": {
-    "@apollo/client": "3.4.11",
+    "@apollo/client": "3.4.16",
     "graphql": "^15.0.0",
     "graphql-tag": "2.12.5"
   },
@@ -41,11 +41,11 @@
     "glob": "7.1.7",
     "jest": "26.6.3",
     "jest-dev-server": "4.4.0",
-    "jest-localstorage-mock": "2.4.17",
+    "jest-localstorage-mock": "2.4.18",
     "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"
+    "typedoc-plugin-markdown": "3.1.1"
   }
 }

package/page.d.ts

@@ -374,7 +374,9 @@ export interface PageApi extends PageApiProperties {
     /**
      * 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
-     * unset modalAutoDetect.
+     * unset modalAutoDetect. Setting additonal selectors replaces the currently set selectors, use
+     * page.getModalQuerySelectors and append new selectors to the returned list before resetting
+     * to modify the existing list of selectors.
      *
      * ***Example:***
      *

package/page.js.map

@@ -1 +1 @@
-{"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"}
+{"version":3,"file":"page.js","sourceRoot":"","sources":["page.ts"],"names":[],"mappings":";AAAA;;;;;;;;;4EAS4E;;AAE5E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AAEH,yCAAqC;AAsarC,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"}

package/page.ts

@@ -439,7 +439,9 @@ export interface PageApi extends PageApiProperties {
   /**
    * 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
-   * unset modalAutoDetect.
+   * unset modalAutoDetect. Setting additonal selectors replaces the currently set selectors, use
+   * page.getModalQuerySelectors and append new selectors to the returned list before resetting
+   * to modify the existing list of selectors.
    *
    * ***Example:***
    *

package/pulse.d.ts

@@ -144,11 +144,33 @@ export interface PulseResponse {
         }[];
     };
 }
+export interface PulseButtonConfig {
+    /**
+     * Text of the button.
+     */
+    label: string;
+    /**
+     * Callback function to be automatically executed on click.
+     */
+    callback?: (value?: any) => void;
+}
 export interface PulseApi {
     /**
      * Method to send a pulse notification.
      */
     send(notifications: PulseNotification[]): Promise<PulseResponse>;
+    /**
+     * Adds an additional custom button to the bottom of the Pulse container.
+     * Will fire the attached callback when a user presses the button.
+     * @param buttonConfig The button configuration
+     */
+    setButton(buttonConfig: PulseButtonConfig): void;
+    /**
+     * Adds additional values to the notification.
+     * If Pulse has 3 internally and this is set to 2, the UI will show 5.
+     * @param count Additional values to add to the pulse notification.
+     */
+    setCount(count: number): void;
 }
 declare const pulse: PulseApi;
 export default pulse;

package/pulse.js

@@ -101,6 +101,12 @@ var NotificationType;
 const pulse = {
     send: params => {
         return Global_1.getImpl('pulse')().send(params);
+    },
+    setButton: (buttonConfig) => {
+        return Global_1.getImpl('pulse')().setButton(buttonConfig);
+    },
+    setCount: (count) => {
+        return Global_1.getImpl('pulse')().setCount(count);
     }
 };
 exports.default = pulse;

package/pulse.js.map

@@ -1 +1 @@
-{"version":3,"file":"pulse.js","sourceRoot":"","sources":["pulse.ts"],"names":[],"mappings":";AAAA;;;;;;;;;4EAS4E;AAC5E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;;;AAEH,yCAAqC;AAErC;;GAEG;AACH,IAAY,gBAiDX;AAjDD,WAAY,gBAAgB;IAC1B;;OAEG;IACH,yDAAqC,CAAA;IACrC;;OAEG;IACH,uEAAmD,CAAA;IACnD;;OAEG;IACH,qDAAiC,CAAA;IACjC;;OAEG;IACH,mEAA+C,CAAA;IAC/C;;OAEG;IACH,yCAAqB,CAAA;IACrB;;OAEG;IACH,qCAAiB,CAAA;IACjB;;OAEG;IACH,yCAAqB,CAAA;IACrB;;OAEG;IACH,iFAA6D,CAAA;IAC7D;;OAEG;IACH,yEAAqD,CAAA;IACrD;;OAEG;IACH,mEAA+C,CAAA;IAC/C;;OAEG;IACH,oEAAgD,CAAA;IAChD;;OAEG;IACH,qCAAiB,CAAA;AACnB,CAAC,EAjDW,gBAAgB,GAAhB,wBAAgB,KAAhB,wBAAgB,QAiD3B;AA8DD,MAAM,KAAK,GAAa;IACtB,IAAI,EAAE,MAAM,CAAC,EAAE;QACb,OAAO,gBAAO,CAAC,OAAO,CAAC,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACzC,CAAC;CACF,CAAC;AAEF,kBAAe,KAAK,CAAC"}
+{"version":3,"file":"pulse.js","sourceRoot":"","sources":["pulse.ts"],"names":[],"mappings":";AAAA;;;;;;;;;4EAS4E;AAC5E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;;;AAEH,yCAAqC;AAErC;;GAEG;AACH,IAAY,gBAiDX;AAjDD,WAAY,gBAAgB;IAC1B;;OAEG;IACH,yDAAqC,CAAA;IACrC;;OAEG;IACH,uEAAmD,CAAA;IACnD;;OAEG;IACH,qDAAiC,CAAA;IACjC;;OAEG;IACH,mEAA+C,CAAA;IAC/C;;OAEG;IACH,yCAAqB,CAAA;IACrB;;OAEG;IACH,qCAAiB,CAAA;IACjB;;OAEG;IACH,yCAAqB,CAAA;IACrB;;OAEG;IACH,iFAA6D,CAAA;IAC7D;;OAEG;IACH,yEAAqD,CAAA;IACrD;;OAEG;IACH,mEAA+C,CAAA;IAC/C;;OAEG;IACH,oEAAgD,CAAA;IAChD;;OAEG;IACH,qCAAiB,CAAA;AACnB,CAAC,EAjDW,gBAAgB,GAAhB,wBAAgB,KAAhB,wBAAgB,QAiD3B;AAwFD,MAAM,KAAK,GAAa;IACtB,IAAI,EAAE,MAAM,CAAC,EAAE;QACb,OAAO,gBAAO,CAAC,OAAO,CAAC,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACzC,CAAC;IACD,SAAS,EAAE,CAAC,YAA+B,EAAE,EAAE;QAC7C,OAAO,gBAAO,CAAC,OAAO,CAAC,EAAE,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC;IACpD,CAAC;IACD,QAAQ,EAAE,CAAC,KAAa,EAAE,EAAE;QAC1B,OAAO,gBAAO,CAAC,OAAO,CAAC,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IAC5C,CAAC;CACF,CAAC;AAEF,kBAAe,KAAK,CAAC"}

package/pulse.ts

@@ -150,16 +150,48 @@ export interface PulseResponse {
   };
 }
 
+export interface PulseButtonConfig {
+  /**
+   * Text of the button.
+   */
+  label: string;
+
+  /**
+   * Callback function to be automatically executed on click.
+   */
+  callback?: (value?: any) => void;
+}
+
 export interface PulseApi {
   /**
    * Method to send a pulse notification.
    */
   send(notifications: PulseNotification[]): Promise<PulseResponse>;
+
+  /**
+   * Adds an additional custom button to the bottom of the Pulse container.
+   * Will fire the attached callback when a user presses the button.
+   * @param buttonConfig The button configuration
+   */
+  setButton(buttonConfig: PulseButtonConfig): void;
+
+  /**
+   * Adds additional values to the notification.
+   * If Pulse has 3 internally and this is set to 2, the UI will show 5.
+   * @param count Additional values to add to the pulse notification.
+   */
+  setCount(count: number): void;
 }
 
 const pulse: PulseApi = {
   send: params => {
     return getImpl('pulse')().send(params);
+  },
+  setButton: (buttonConfig: PulseButtonConfig) => {
+    return getImpl('pulse')().setButton(buttonConfig);
+  },
+  setCount: (count: number) => {
+    return getImpl('pulse')().setCount(count);
   }
 };
 

package/tests/pulse.test.js

@@ -19,7 +19,9 @@ describe('pulse.ts', () => {
     it('correctly sets up the connection with module-runtime', () => {
         // setup
         const pulseMock = {
-            send: () => Promise.resolve({ notifications: { notification: [] } })
+            send: () => Promise.resolve({ notifications: { notification: [] } }),
+            setButton: () => { },
+            setCount: () => { }
         };
         Global_1.default['exc-module-runtime'] = {
             pulse: () => {

package/tests/pulse.test.js.map

@@ -1 +1 @@
-{"version":3,"file":"pulse.test.js","sourceRoot":"","sources":["pulse.test.ts"],"names":[],"mappings":";;;;;AAAA;;;;;;;;;4EAS4E;AAC5E,2DAA8C;AAC9C,qDAA2E;AAE3E,QAAQ,CAAC,UAAU,EAAE,GAAG,EAAE;IACxB,EAAE,CAAC,sDAAsD,EAAE,GAAG,EAAE;QAC9D,QAAQ;QACR,MAAM,SAAS,GAAG;YAChB,IAAI,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,OAAO,CAAgB,EAAC,aAAa,EAAE,EAAC,YAAY,EAAE,EAAE,EAAC,EAAC,CAAC;SACpE,CAAC;QACb,gBAAM,CAAC,oBAAoB,CAAa,GAAG;YAC1C,KAAK,EAAE,GAAG,EAAE;gBACV,OAAO,SAAS,CAAC;YACnB,CAAC;SACS,CAAC;QACb,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;QAC9C,MAAM,QAAQ,GAAG,CAAC,EAAuB,CAAC,CAAC;QAE3C,SAAS;QACT,eAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAErB,SAAS;QACT,MAAM,CAAC,OAAO,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;QACnC,MAAM,CAAC,OAAO,CAAC,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;IAC3C,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}
+{"version":3,"file":"pulse.test.js","sourceRoot":"","sources":["pulse.test.ts"],"names":[],"mappings":";;;;;AAAA;;;;;;;;;4EAS4E;AAC5E,2DAA8C;AAC9C,qDAA2E;AAE3E,QAAQ,CAAC,UAAU,EAAE,GAAG,EAAE;IACxB,EAAE,CAAC,sDAAsD,EAAE,GAAG,EAAE;QAC9D,QAAQ;QACR,MAAM,SAAS,GAAG;YAChB,IAAI,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,OAAO,CAAgB,EAAC,aAAa,EAAE,EAAC,YAAY,EAAE,EAAE,EAAC,EAAC,CAAC;YAC/E,SAAS,EAAE,GAAG,EAAE,GAAE,CAAC;YACnB,QAAQ,EAAE,GAAG,EAAE,GAAE,CAAC;SACP,CAAC;QACb,gBAAM,CAAC,oBAAoB,CAAa,GAAG;YAC1C,KAAK,EAAE,GAAG,EAAE;gBACV,OAAO,SAAS,CAAC;YACnB,CAAC;SACS,CAAC;QACb,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;QAC9C,MAAM,QAAQ,GAAG,CAAC,EAAuB,CAAC,CAAC;QAE3C,SAAS;QACT,eAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAErB,SAAS;QACT,MAAM,CAAC,OAAO,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;QACnC,MAAM,CAAC,OAAO,CAAC,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;IAC3C,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/tests/pulse.test.ts

@@ -15,7 +15,9 @@ describe('pulse.ts', () => {
   it('correctly sets up the connection with module-runtime', () => {
     // setup
     const pulseMock = {
-      send: () => Promise.resolve<PulseResponse>({notifications: {notification: []}})
+      send: () => Promise.resolve<PulseResponse>({notifications: {notification: []}}),
+      setButton: () => {},
+      setCount: () => {}
     } as PulseApi;
     (Global['exc-module-runtime'] as Modules) = {
       pulse: () => {

package/coverage/lcov-report/block-navigation.js

@@ -1,79 +0,0 @@
-/* eslint-disable */
-var jumpToCode = (function init() {
-    // Classes of code we would like to highlight in the file view
-    var missingCoverageClasses = ['.cbranch-no', '.cstat-no', '.fstat-no'];
-
-    // Elements to highlight in the file listing view
-    var fileListingElements = ['td.pct.low'];
-
-    // We don't want to select elements that are direct descendants of another match
-    var notSelector = ':not(' + missingCoverageClasses.join('):not(') + ') > '; // becomes `:not(a):not(b) > `
-
-    // Selecter that finds elements on the page to which we can jump
-    var selector =
-        fileListingElements.join(', ') +
-        ', ' +
-        notSelector +
-        missingCoverageClasses.join(', ' + notSelector); // becomes `:not(a):not(b) > a, :not(a):not(b) > b`
-
-    // The NodeList of matching elements
-    var missingCoverageElements = document.querySelectorAll(selector);
-
-    var currentIndex;
-
-    function toggleClass(index) {
-        missingCoverageElements
-            .item(currentIndex)
-            .classList.remove('highlighted');
-        missingCoverageElements.item(index).classList.add('highlighted');
-    }
-
-    function makeCurrent(index) {
-        toggleClass(index);
-        currentIndex = index;
-        missingCoverageElements.item(index).scrollIntoView({
-            behavior: 'smooth',
-            block: 'center',
-            inline: 'center'
-        });
-    }
-
-    function goToPrevious() {
-        var nextIndex = 0;
-        if (typeof currentIndex !== 'number' || currentIndex === 0) {
-            nextIndex = missingCoverageElements.length - 1;
-        } else if (missingCoverageElements.length > 1) {
-            nextIndex = currentIndex - 1;
-        }
-
-        makeCurrent(nextIndex);
-    }
-
-    function goToNext() {
-        var nextIndex = 0;
-
-        if (
-            typeof currentIndex === 'number' &&
-            currentIndex < missingCoverageElements.length - 1
-        ) {
-            nextIndex = currentIndex + 1;
-        }
-
-        makeCurrent(nextIndex);
-    }
-
-    return function jump(event) {
-        switch (event.which) {
-            case 78: // n
-            case 74: // j
-                goToNext();
-                break;
-            case 66: // b
-            case 75: // k
-            case 80: // p
-                goToPrevious();
-                break;
-        }
-    };
-})();
-window.addEventListener('keydown', jumpToCode);