@adobe/exc-app 0.2.42 → 0.2.44-beta

package/docs/interfaces/root.runtimeconfiguration.md

@@ -0,0 +1,392 @@
+**[@adobe/exc-app](../README.md)**
+
+> [Globals](../README.md) / [root](../modules/root.md) / RuntimeConfiguration
+
+# Interface: RuntimeConfiguration
+
+External Runtime Configuration Interface
+
+## Hierarchy
+
+* **RuntimeConfiguration**
+
+## Index
+
+### Properties
+
+* [analytics](root.runtimeconfiguration.md#analytics)
+* [apiGatewayUrl](root.runtimeconfiguration.md#apigatewayurl)
+* [appContainer](root.runtimeconfiguration.md#appcontainer)
+* [appId](root.runtimeconfiguration.md#appid)
+* [baseFrameUrl](root.runtimeconfiguration.md#baseframeurl)
+* [baseUrl](root.runtimeconfiguration.md#baseurl)
+* [changedProperties](root.runtimeconfiguration.md#changedproperties)
+* [discovery](root.runtimeconfiguration.md#discovery)
+* [environment](root.runtimeconfiguration.md#environment)
+* [externalQueryParams](root.runtimeconfiguration.md#externalqueryparams)
+* [featureFlags](root.runtimeconfiguration.md#featureflags)
+* [gainsight](root.runtimeconfiguration.md#gainsight)
+* [gqlEndpoint](root.runtimeconfiguration.md#gqlendpoint)
+* [historyType](root.runtimeconfiguration.md#historytype)
+* [hosts](root.runtimeconfiguration.md#hosts)
+* [imsClientId](root.runtimeconfiguration.md#imsclientid)
+* [imsEnvironment](root.runtimeconfiguration.md#imsenvironment)
+* [imsInfo](root.runtimeconfiguration.md#imsinfo)
+* [imsOrg](root.runtimeconfiguration.md#imsorg)
+* [imsOrgName](root.runtimeconfiguration.md#imsorgname)
+* [imsOrgs](root.runtimeconfiguration.md#imsorgs)
+* [imsProfile](root.runtimeconfiguration.md#imsprofile)
+* [imsToken](root.runtimeconfiguration.md#imstoken)
+* [ioGatewayUrl](root.runtimeconfiguration.md#iogatewayurl)
+* [ioRegionSpecificMap](root.runtimeconfiguration.md#ioregionspecificmap)
+* [locale](root.runtimeconfiguration.md#locale)
+* [metricsAppId](root.runtimeconfiguration.md#metricsappid)
+* [metricsConfig](root.runtimeconfiguration.md#metricsconfig)
+* [metricsEnv](root.runtimeconfiguration.md#metricsenv)
+* [preferredLanguages](root.runtimeconfiguration.md#preferredlanguages)
+* [sandbox](root.runtimeconfiguration.md#sandbox)
+* [shellHeight](root.runtimeconfiguration.md#shellheight)
+* [shellInfo](root.runtimeconfiguration.md#shellinfo)
+* [shellSideNavCollapsed](root.runtimeconfiguration.md#shellsidenavcollapsed)
+* [shellSideNavPresent](root.runtimeconfiguration.md#shellsidenavpresent)
+* [shellSideNavWidth](root.runtimeconfiguration.md#shellsidenavwidth)
+* [spaAppId](root.runtimeconfiguration.md#spaappid)
+* [subOrg](root.runtimeconfiguration.md#suborg)
+* [tenant](root.runtimeconfiguration.md#tenant)
+* [tenantAppId](root.runtimeconfiguration.md#tenantappid)
+* [theme](root.runtimeconfiguration.md#theme)
+* [xqlGatewayUrl](root.runtimeconfiguration.md#xqlgatewayurl)
+
+## Properties
+
+### analytics
+
+• `Optional` **analytics**: undefined \| { script: string ; solution: string  }
+
+OMEGA Launch script properties
+
+___
+
+### apiGatewayUrl
+
+•  **apiGatewayUrl**: string
+
+Unified Shell API Gateway URL
+
+___
+
+### appContainer
+
+•  **appContainer**: string
+
+App Container
+
+___
+
+### appId
+
+•  **appId**: string
+
+Solution appId
+
+___
+
+### baseFrameUrl
+
+•  **baseFrameUrl**: string
+
+Solution iframe src url
+
+___
+
+### baseUrl
+
+•  **baseUrl**: string
+
+Base URL
+
+___
+
+### changedProperties
+
+•  **changedProperties**: keyof [RuntimeConfiguration](root.runtimeconfiguration.md)[]
+
+List all properties changed in this configuration compared to the previous one sent
+
+___
+
+### discovery
+
+•  **discovery**: boolean
+
+If discovery URL
+
+___
+
+### environment
+
+•  **environment**: string
+
+Unified Shell's environment
+
+___
+
+### externalQueryParams
+
+•  **externalQueryParams**: string
+
+Query params
+
+___
+
+### featureFlags
+
+• `Optional` **featureFlags**: Record<string, string\>
+
+List of feature flags
+
+___
+
+### gainsight
+
+• `Optional` **gainsight**: undefined \| { enabled: boolean ; productKey: string  }
+
+Gainsight configuration.
+
+___
+
+### gqlEndpoint
+
+• `Optional` **gqlEndpoint**: undefined \| string
+
+Clients can pass in their local GQL endpoint
+
+___
+
+### historyType
+
+•  **historyType**: \"HASH\" \| \"HISTORY\" \| \"SERVER\"
+
+Solution History type
+
+___
+
+### hosts
+
+• `Optional` **hosts**: string[]
+
+Solution's list of multiple subdomains
+
+___
+
+### imsClientId
+
+•  **imsClientId**: string
+
+IMS Client ID
+
+___
+
+### imsEnvironment
+
+•  **imsEnvironment**: string
+
+IMS env
+
+___
+
+### imsInfo
+
+•  **imsInfo**: ImsInfo
+
+IMS Information
+
+___
+
+### imsOrg
+
+•  **imsOrg**: string
+
+Current IMS Org ID
+
+___
+
+### imsOrgName
+
+•  **imsOrgName**: string
+
+Current IMS Org Name
+
+___
+
+### imsOrgs
+
+•  **imsOrgs**: Array<Record<string, ImsOrg\>\>
+
+ImsOrg Interface
+
+___
+
+### imsProfile
+
+• `Optional` **imsProfile**: undefined \| { authId: string ; displayName: string ; session: string ; userId: string  }
+
+User IMS Profile
+
+___
+
+### imsToken
+
+•  **imsToken**: string
+
+IMS Token
+
+___
+
+### ioGatewayUrl
+
+• `Optional` **ioGatewayUrl**: undefined \| string
+
+Adobe IO gateway URL used as a fallback in GQL call
+
+___
+
+### ioRegionSpecificMap
+
+• `Optional` **ioRegionSpecificMap**: Record<string, string\>
+
+Map of Adobe Io region specific endpoints.
+
+___
+
+### locale
+
+•  **locale**: string
+
+User Locale
+
+___
+
+### metricsAppId
+
+• `Optional` **metricsAppId**: undefined \| string
+
+Solution metricsAppId
+
+___
+
+### metricsConfig
+
+•  **metricsConfig**: MetricsConfiguration
+
+AdobeMetricsRuntime Configuration
+
+___
+
+### metricsEnv
+
+• `Optional` **metricsEnv**: undefined \| string
+
+Metrics environment (may differ from environment)
+
+___
+
+### preferredLanguages
+
+• `Optional` **preferredLanguages**: string[]
+
+List of languages from user's preferences
+
+___
+
+### sandbox
+
+• `Optional` **sandbox**: [Sandbox](user.sandbox.md)
+
+Current Sandbox
+
+___
+
+### shellHeight
+
+•  **shellHeight**: number
+
+Shell Height
+
+___
+
+### shellInfo
+
+• `Optional` **shellInfo**: Record<string, any\>
+
+Shell Info
+
+___
+
+### shellSideNavCollapsed
+
+• `Optional` **shellSideNavCollapsed**: undefined \| false \| true
+
+Is Side Nav collapsed?
+
+___
+
+### shellSideNavPresent
+
+•  **shellSideNavPresent**: boolean
+
+Is Side Nav enabled?
+
+___
+
+### shellSideNavWidth
+
+•  **shellSideNavWidth**: number
+
+Side Nav width
+
+___
+
+### spaAppId
+
+• `Optional` **spaAppId**: undefined \| string
+
+SPA pipeline app id
+
+___
+
+### subOrg
+
+• `Optional` **subOrg**: Record<string, any\>
+
+Sub Org
+
+___
+
+### tenant
+
+•  **tenant**: string
+
+Tenant ID
+
+___
+
+### tenantAppId
+
+• `Optional` **tenantAppId**: undefined \| string
+
+**`deprecated`** Solution GraphQL tenantAppId
+
+___
+
+### theme
+
+•  **theme**: string
+
+___
+
+### xqlGatewayUrl
+
+• `Optional` **xqlGatewayUrl**: undefined \| string
+
+XQL gateway used for AEP specific queries

package/docs/interfaces/session.sessionapi.md

@@ -24,11 +24,11 @@ rather cache and recycle them whenever possible.
 
 ### get
 
-▸ **get**(): Promise\<[Session](session.session-1.md)>
+▸ **get**(): Promise<[Session](session.session-1.md)\>
 
 Gets a stored session if one is available.
 
-**Returns:** Promise\<[Session](session.session-1.md)>
+**Returns:** Promise<[Session](session.session-1.md)\>
 
 Session object
 
@@ -36,7 +36,7 @@ ___
 
 ### invalidate
 
-▸ **invalidate**(`session`: [Session](session.session-1.md)): Promise\<void>
+▸ **invalidate**(`session`: [Session](session.session-1.md)): Promise<void\>
 
 Invalidates a session if its current.
 
@@ -46,13 +46,13 @@ Name | Type |
 ------ | ------ |
 `session` | [Session](session.session-1.md) |
 
-**Returns:** Promise\<void>
+**Returns:** Promise<void\>
 
 ___
 
 ### set
 
-▸ **set**(`session`: [Session](session.session-1.md)): Promise\<void>
+▸ **set**(`session`: [Session](session.session-1.md)): Promise<void\>
 
 Stores the current session
 
@@ -62,4 +62,4 @@ Name | Type |
 ------ | ------ |
 `session` | [Session](session.session-1.md) |
 
-**Returns:** Promise\<void>
+**Returns:** Promise<void\>

package/docs/interfaces/settings.parameters.md

@@ -2,7 +2,7 @@
 
 > [Globals](../README.md) / [settings](../modules/settings.md) / Parameters
 
-# Interface: Parameters\<T>
+# Interface: Parameters<T\>
 
 The input parameters for the settings API.
 

package/docs/interfaces/settings.settingsapi.md

@@ -22,7 +22,7 @@ at an IMS user and/or an IMS org level. An app in unified shell can consume Sett
 
 ### get
 
-▸ **get**\<T>(`params`: [Parameters](settings.parameters.md)\<T>): Promise\<[SettingsResponse](settings.settingsresponse.md)\<T>>
+▸ **get**<T\>(`params`: [Parameters](settings.parameters.md)<T\>): Promise<[SettingsResponse](settings.settingsresponse.md)<T\>\>
 
 Gets settings based on the specified parameters such as groupId
 and settings - keys with default values to fallback.
@@ -37,9 +37,9 @@ Name | Type |
 
 Name | Type | Description |
 ------ | ------ | ------ |
-`params` | [Parameters](settings.parameters.md)\<T> | Parameters used to identify settings to retrieve. |
+`params` | [Parameters](settings.parameters.md)<T\> | Parameters used to identify settings to retrieve. |
 
-**Returns:** Promise\<[SettingsResponse](settings.settingsresponse.md)\<T>>
+**Returns:** Promise<[SettingsResponse](settings.settingsresponse.md)<T\>\>
 
 A promise for the specified settings.
 
@@ -47,7 +47,7 @@ ___
 
 ### set
 
-▸ **set**\<T>(`params`: [Parameters](settings.parameters.md)\<T>): Promise\<[SettingsResponse](settings.settingsresponse.md)\<T>>
+▸ **set**<T\>(`params`: [Parameters](settings.parameters.md)<T\>): Promise<[SettingsResponse](settings.settingsresponse.md)<T\>\>
 
 Creates or updates settings based on the specified parameters such as groupId and settings
 key-value pairs.
@@ -62,8 +62,8 @@ Name | Type |
 
 Name | Type | Description |
 ------ | ------ | ------ |
-`params` | [Parameters](settings.parameters.md)\<T> | Parameters to identify the settings to create or update. |
+`params` | [Parameters](settings.parameters.md)<T\> | Parameters to identify the settings to create or update. |
 
-**Returns:** Promise\<[SettingsResponse](settings.settingsresponse.md)\<T>>
+**Returns:** Promise<[SettingsResponse](settings.settingsresponse.md)<T\>\>
 
 A promise for the operation response.

package/docs/interfaces/settings.settingsresponse.md

@@ -2,7 +2,7 @@
 
 > [Globals](../README.md) / [settings](../modules/settings.md) / SettingsResponse
 
-# Interface: SettingsResponse\<T>
+# Interface: SettingsResponse<T\>
 
 The response from the settings service.
 

package/docs/interfaces/shell.shellapi.md

@@ -6,7 +6,7 @@
 
 ## Hierarchy
 
-* EventEmitter\<ShellInfoEvent>
+* EventEmitter<ShellInfoEvent\>
 
   ↳ **ShellApi**
 
@@ -26,7 +26,7 @@
 
 ### emit
 
-▸ **emit**\<K>(`type`: K, `event?`: ShellInfoEvent[K]): void
+▸ **emit**<K\>(`type`: K, `event?`: ShellInfoEvent[K]): void
 
 *Inherited from void*
 
@@ -51,7 +51,7 @@ ___
 
 ### off
 
-▸ **off**\<K>(`type`: K, `handler`: (event?: ShellInfoEvent[K]) => void): void
+▸ **off**<K\>(`type`: K, `handler`: (event?: ShellInfoEvent[K]) => void): void
 
 *Inherited from void*
 
@@ -76,7 +76,7 @@ ___
 
 ### on
 
-▸ **on**\<K>(`type`: K, `handler`: (event?: ShellInfoEvent[K]) => void): void
+▸ **on**<K\>(`type`: K, `handler`: (event?: ShellInfoEvent[K]) => void): void
 
 *Inherited from void*
 
@@ -103,7 +103,7 @@ ___
 
 ### get
 
-▸ **get**\<T>(`type`: T): Promise\<ShellInfo[T]>
+▸ **get**<T\>(`type`: T): Promise<ShellInfo[T]\>
 
 Gets the specified type of information about the shell.
 
@@ -119,4 +119,4 @@ Name | Type | Description |
 ------ | ------ | ------ |
 `type` | T | The type of information to get.  |
 
-**Returns:** Promise\<ShellInfo[T]>
+**Returns:** Promise<ShellInfo[T]\>

package/docs/interfaces/shell.shellinfo.md

@@ -32,4 +32,4 @@ ___
 
 ### shellInfo
 
-•  **shellInfo**: Record\<string, any>
+•  **shellInfo**: Record<string, any\>

package/docs/interfaces/user.imsinfo.md

@@ -37,7 +37,7 @@ ___
 
 ### imsProfile
 
-• `Optional` **imsProfile**: Record\<string, any>
+• `Optional` **imsProfile**: Record<string, any\>
 
 ___
 

package/docs/interfaces/user.userapi.md

@@ -6,7 +6,7 @@
 
 ## Hierarchy
 
-* EventEmitter\<UserInfoEvent>
+* EventEmitter<UserInfoEvent\>
 
   ↳ **UserApi**
 
@@ -50,7 +50,7 @@ If language picker should be opened.
 
 ### emit
 
-▸ **emit**\<K>(`type`: K, `event?`: UserInfoEvent[K]): void
+▸ **emit**<K\>(`type`: K, `event?`: UserInfoEvent[K]): void
 
 *Inherited from void*
 
@@ -75,7 +75,7 @@ ___
 
 ### off
 
-▸ **off**\<K>(`type`: K, `handler`: (event?: UserInfoEvent[K]) => void): void
+▸ **off**<K\>(`type`: K, `handler`: (event?: UserInfoEvent[K]) => void): void
 
 *Inherited from void*
 
@@ -100,7 +100,7 @@ ___
 
 ### on
 
-▸ **on**\<K>(`type`: K, `handler`: (event?: UserInfoEvent[K]) => void): void
+▸ **on**<K\>(`type`: K, `handler`: (event?: UserInfoEvent[K]) => void): void
 
 *Inherited from void*
 
@@ -138,7 +138,7 @@ ___
 
 ### get
 
-▸ **get**\<T>(`type`: T): Promise\<UserInfo[T]>
+▸ **get**<T\>(`type`: T): Promise<UserInfo[T]\>
 
 Gets the specified type of information about an user.
 
@@ -154,4 +154,4 @@ Name | Type | Description |
 ------ | ------ | ------ |
 `type` | T | The type of information to get.  |
 
-**Returns:** Promise\<UserInfo[T]>
+**Returns:** Promise<UserInfo[T]\>

package/docs/interfaces/user.userinfo.md

@@ -54,7 +54,7 @@ ___
 
 ### imsProfile
 
-•  **imsProfile**: Record\<string, any>
+•  **imsProfile**: Record<string, any\>
 
 ___
 
@@ -84,7 +84,7 @@ ___
 
 ### sandboxes
 
-•  **sandboxes**: Array\<[Sandbox](user.sandbox.md)>
+•  **sandboxes**: Array<[Sandbox](user.sandbox.md)\>
 
 ___
 

package/docs/modules/metrics.md

@@ -4,14 +4,45 @@
 
 # Module: metrics
 
-Copyright 2020 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.
+API used to log messages, errors, events, metrics and analytics that get pushed to our telemetry
+system.
+
+The main goal of this project is to provide solutions that are integrating with Unified-Shell and
+running on Adobe Experience Cloud as much telemetry information as possible "for free" and a
+convenient integration option to collect custom, application specific metrics.
+
+***Import:***
+
+```typescript
+import metrics from '@adobe/exc-app/metrics';
+```
+
+***Type:***
+
+[MetricsApi](../interfaces/metrics.metricsapi.md#interface-metricsapi)
+
+***Usage:***
+
+```typescript
+import metrics from '@adobe/exc-app/metrics';
+
+class MyClass {
+  constructor() {
+    this.metrics = metrics.create('exc.landing-page.recents');
+  }
+
+  async someOperation() {
+    const timer = this.metrics.start('MyClass.someOperation');
+    try {
+      await performOperation();
+      timer.time('done');
+    } catch(err) {
+      this.metrics.error(error);
+      throw err;
+    }
+  }
+}
+```
 
 ## Index