@adobe/exc-app 0.2.43 → 0.2.44-beta

package/appapi.d.ts

@@ -55,6 +55,7 @@ export declare enum AppIds {
     CUSTOMER_JOURNEY_ANALYTICS = "platformAnalytics",
     CUSTOMER_JOURNEY_MANAGEMENT = "cjm-home",
     DATA_COLLECTION = "launchDataCollection",
+    DYNAMIC_CHAT = "hummingbird",
     EXCHANGE = "exchange",
     EXPERIENCE_CLOUD = "landing",
     EXPERIENCE_MANAGER = "experienceManagerUI",

package/appapi.js

@@ -61,6 +61,7 @@ var AppIds;
     AppIds["CUSTOMER_JOURNEY_ANALYTICS"] = "platformAnalytics";
     AppIds["CUSTOMER_JOURNEY_MANAGEMENT"] = "cjm-home";
     AppIds["DATA_COLLECTION"] = "launchDataCollection";
+    AppIds["DYNAMIC_CHAT"] = "hummingbird";
     AppIds["EXCHANGE"] = "exchange";
     AppIds["EXPERIENCE_CLOUD"] = "landing";
     AppIds["EXPERIENCE_MANAGER"] = "experienceManagerUI";

package/appapi.js.map

@@ -1 +1 @@
-{"version":3,"file":"appapi.js","sourceRoot":"","sources":["appapi.ts"],"names":[],"mappings":";AAAA;;;;;;;;;4EAS4E;;;AAE5E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AAEH,yCAAqC;AAiCrC,0DAA0D;AAC1D,IAAY,MA4CX;AA5CD,WAAY,MAAM;IAChB,yBAAe,CAAA;IACf,wCAA8B,CAAA;IAC9B,oDAA0C,CAAA;IAC1C,uCAA6B,CAAA;IAC7B,iCAAuB,CAAA;IACvB,2BAAiB,CAAA;IACjB,oCAA0B,CAAA;IAC1B,8CAAoC,CAAA;IACpC,6BAAmB,CAAA;IACnB,0BAAgB,CAAA;IAChB,yCAA+B,CAAA;IAC/B,0CAAgC,CAAA;IAChC,gEAAsD,CAAA;IACtD,0DAAgD,CAAA;IAChD,kDAAwC,CAAA;IACxC,kDAAwC,CAAA;IACxC,+BAAqB,CAAA;IACrB,sCAA4B,CAAA;IAC5B,oDAA0C,CAAA;IAC1C,4DAAkD,CAAA;IAClD,gDAAsC,CAAA;IACtC,sDAA4C,CAAA;IAC5C,+BAAqB,CAAA;IACrB,wCAA8B,CAAA;IAC9B,4CAAkC,CAAA;IAClC,8CAAoC,CAAA;IACpC,wCAA8B,CAAA;IAC9B,kCAAwB,CAAA;IACxB,sCAA4B,CAAA;IAC5B,oCAA0B,CAAA;IAC1B,2BAAiB,CAAA;IACjB,2BAAiB,CAAA;IACjB,mCAAyB,CAAA;IACzB,iCAAuB,CAAA;IACvB,kCAAwB,CAAA;IACxB,0CAAgC,CAAA;IAChC,6CAAmC,CAAA;IACnC,qCAA2B,CAAA;IAC3B,qDAA2C,CAAA;IAC3C,wDAA8C,CAAA;IAC9C,wCAA8B,CAAA;IAC9B,2BAAiB,CAAA;IACjB,+BAAqB,CAAA;AACvB,CAAC,EA5CW,MAAM,GAAN,cAAM,KAAN,cAAM,QA4CjB;AAWD,MAAM,MAAM,GAAW;IACrB,GAAG,EAAE,MAAM,CAAC,EAAE;QACZ,OAAO,gBAAO,CAAC,QAAQ,CAAC,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IACzC,CAAC;CACF,CAAC;AAEF,kBAAe,MAAM,CAAC"}
+{"version":3,"file":"appapi.js","sourceRoot":"","sources":["appapi.ts"],"names":[],"mappings":";AAAA;;;;;;;;;4EAS4E;;;AAE5E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AAEH,yCAAqC;AAiCrC,0DAA0D;AAC1D,IAAY,MA6CX;AA7CD,WAAY,MAAM;IAChB,yBAAe,CAAA;IACf,wCAA8B,CAAA;IAC9B,oDAA0C,CAAA;IAC1C,uCAA6B,CAAA;IAC7B,iCAAuB,CAAA;IACvB,2BAAiB,CAAA;IACjB,oCAA0B,CAAA;IAC1B,8CAAoC,CAAA;IACpC,6BAAmB,CAAA;IACnB,0BAAgB,CAAA;IAChB,yCAA+B,CAAA;IAC/B,0CAAgC,CAAA;IAChC,gEAAsD,CAAA;IACtD,0DAAgD,CAAA;IAChD,kDAAwC,CAAA;IACxC,kDAAwC,CAAA;IACxC,sCAA4B,CAAA;IAC5B,+BAAqB,CAAA;IACrB,sCAA4B,CAAA;IAC5B,oDAA0C,CAAA;IAC1C,4DAAkD,CAAA;IAClD,gDAAsC,CAAA;IACtC,sDAA4C,CAAA;IAC5C,+BAAqB,CAAA;IACrB,wCAA8B,CAAA;IAC9B,4CAAkC,CAAA;IAClC,8CAAoC,CAAA;IACpC,wCAA8B,CAAA;IAC9B,kCAAwB,CAAA;IACxB,sCAA4B,CAAA;IAC5B,oCAA0B,CAAA;IAC1B,2BAAiB,CAAA;IACjB,2BAAiB,CAAA;IACjB,mCAAyB,CAAA;IACzB,iCAAuB,CAAA;IACvB,kCAAwB,CAAA;IACxB,0CAAgC,CAAA;IAChC,6CAAmC,CAAA;IACnC,qCAA2B,CAAA;IAC3B,qDAA2C,CAAA;IAC3C,wDAA8C,CAAA;IAC9C,wCAA8B,CAAA;IAC9B,2BAAiB,CAAA;IACjB,+BAAqB,CAAA;AACvB,CAAC,EA7CW,MAAM,GAAN,cAAM,KAAN,cAAM,QA6CjB;AAWD,MAAM,MAAM,GAAW;IACrB,GAAG,EAAE,MAAM,CAAC,EAAE;QACZ,OAAO,gBAAO,CAAC,QAAQ,CAAC,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IACzC,CAAC;CACF,CAAC;AAEF,kBAAe,MAAM,CAAC"}

package/appapi.ts

@@ -91,6 +91,7 @@ export enum AppIds {
   CUSTOMER_JOURNEY_ANALYTICS = 'platformAnalytics',
   CUSTOMER_JOURNEY_MANAGEMENT = 'cjm-home',
   DATA_COLLECTION = 'launchDataCollection',
+  DYNAMIC_CHAT = 'hummingbird',
   EXCHANGE = 'exchange',
   EXPERIENCE_CLOUD = 'landing',
   EXPERIENCE_MANAGER = 'experienceManagerUI',

package/build/preBuild.js

@@ -22,6 +22,7 @@ const capabilities = require('../../core/src/services/CapabilityConstants/capabi
 const DEFAULT_APP_IDS = {
   CUSTOMER_JOURNEY_MANAGEMENT: 'cjm-home',
   LAUNCH_IMPLEMENT: 'implement',
+  PROJECT_HUMMINGBIRD: 'hummingbird',
   PROJECT_SIERRA: 'cjm-home'
 };
 

package/docs/modules/settings.md

@@ -4,14 +4,63 @@
 
 # Module: settings
 
-Copyright 2021 Adobe
-All Rights Reserved.
-
-NOTICE: Adobe permits you to use, modify, and distribute this file in
-accordance with the terms of the Adobe license agreement accompanying
-it. If you have received this file from a source other than Adobe,
-then your use, modification, or distribution of it requires the prior
-written permission of Adobe.
+APIs to get or set settings, preferences or configuration data that can be stored and retrieved
+at an IMS user and/or an IMS org level. An app in unified shell can consume Settings service.
+
+To consume this API, add the following import to your code.
+
+```typescript
+import settings from '@adobe/exc-app/settings';
+```
+
+The default export is an object of type [SettingsApi](../interfaces/_settings_.settingsapi.md)
+
+API reference: [scroll down](#index)
+
+### Sample code
+
+```typescript
+import settings, {SettingsLevel} from '@adobe/exc-app/settings';
+
+async function updateSettings(type: string, value: number) {
+  const data = await settings.get({
+    groupId: 'test-groupId',
+    level: SettingsLevel.USER,
+    settings: {key1: null}
+  });
+  data = data || {};
+  data[type] = value;
+  await settings.set({
+    groupId: 'test-groupId',
+    level: SettingsLevel.USER,
+    settings: {key1: data}
+  });
+}
+```
+
+### SettingsLevel
+
+Can be optionally specified to define the level at which settings are saved.
+
+* `SettingsLevel.USER` - use this level when you want to get/set settings per user.
+* `SettingsLevel.USERORG` - should be used when settings are for user + org combination.
+* `SettingsLevel.ORG` - use this level when you want to get/set settings per org.
+
+By default settings are saved at level `SettingsLevel.USERORG`. You can optionally override this
+in the get/set API calls using the `level` parameter.
+
+### Groups
+
+Apps can group their settings into different groups by different group IDs and keep multiple
+settings in different groups. Apps are free to define their own groups for a particular selected
+settings level.
+
+You can specify this in the get/set API calls using the `groupId` parameter.
+
+### Sharing settings
+
+Set settingsAppId in the solution specific route configuration in order to share settings with
+other applications.
 
 ## Index
 

package/internal.d.ts

@@ -18,14 +18,35 @@ import MetricsConfiguration from './metrics/Configuration';
 import { Configuration as NetworkConfiguration } from './network';
 import User from './metrics/User';
 export type { Modules };
+export declare enum PollingStrategy {
+    VISIBILITY = "VISIBILITY",
+    IDLENESS = "IDLENESS"
+}
+export interface Poller {
+    activeFrequency: number;
+    name: string;
+    inactiveFrequency: number;
+    immediate: boolean;
+    pollFn: () => Promise<void>;
+    strategy: PollingStrategy;
+}
+export interface PollerHandle {
+    handle: string;
+}
+export interface PollingConfiguration {
+    strategy: PollingStrategy;
+}
 /**
  * @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>;
+    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 +55,12 @@ 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 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

@@ -10,21 +10,35 @@
  * written permission of Adobe.
  **************************************************************************/
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Internal = void 0;
+exports.Internal = exports.PollingStrategy = void 0;
 const Global_1 = require("./src/Global");
+var PollingStrategy;
+(function (PollingStrategy) {
+    PollingStrategy["VISIBILITY"] = "VISIBILITY";
+    PollingStrategy["IDLENESS"] = "IDLENESS";
+})(PollingStrategy = exports.PollingStrategy || (exports.PollingStrategy = {}));
 /**
  * @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 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;;;AAO5E,yCAA8C;AAO9C,IAAY,eAGX;AAHD,WAAY,eAAe;IACzB,4CAAyB,CAAA;IACzB,wCAAqB,CAAA;AACvB,CAAC,EAHW,eAAe,GAAf,uBAAe,KAAf,uBAAe,QAG1B;AAmCD;;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,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;AA/BD,4BA+BC"}

package/internal.ts

@@ -21,14 +21,39 @@ import User from './metrics/User';
 
 export type {Modules};
 
+export enum PollingStrategy {
+  VISIBILITY = 'VISIBILITY',
+  IDLENESS = 'IDLENESS'
+}
+
+export interface Poller {
+  activeFrequency: number;
+  name: string;
+  inactiveFrequency: number;
+  immediate: boolean;
+  pollFn: () => Promise<void>;
+  strategy: PollingStrategy;
+}
+
+export interface PollerHandle {
+  handle: string;
+}
+
+export interface PollingConfiguration {
+  strategy: PollingStrategy;
+}
+
 /**
  * @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>;
+  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 +63,24 @@ 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 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",
+  "version": "0.2.44-beta",
   "main": "index.js",
   "source": "index.ts",
   "scripts": {
@@ -26,7 +26,7 @@
     "registry": "https://registry.npmjs.com/"
   },
   "dependencies": {
-    "@apollo/client": "3.4.14",
+    "@apollo/client": "3.4.16",
     "graphql": "^15.0.0",
     "graphql-tag": "2.12.5"
   },