@adobe/exc-app 0.2.46 → 1.0.1

package/docs/interfaces/ims.productcontext.md

@@ -0,0 +1,141 @@
+**[@adobe/exc-app](../README.md)**
+
+> [Globals](../README.md) / [ims](../modules/ims.md) / ProductContext
+
+# Interface: ProductContext
+
+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.
+
+## Hierarchy
+
+* **ProductContext**
+
+## Indexable
+
+▪ [key: string]: any
+
+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.
+
+## Index
+
+### Properties
+
+* [createDts](ims.productcontext.md#createdts)
+* [geo](ims.productcontext.md#geo)
+* [global\_company\_id](ims.productcontext.md#global_company_id)
+* [groupid](ims.productcontext.md#groupid)
+* [ident](ims.productcontext.md#ident)
+* [label](ims.productcontext.md#label)
+* [login\_company](ims.productcontext.md#login_company)
+* [migration\_status](ims.productcontext.md#migration_status)
+* [modDts](ims.productcontext.md#moddts)
+* [offer\_id](ims.productcontext.md#offer_id)
+* [owningEntity](ims.productcontext.md#owningentity)
+* [serviceCode](ims.productcontext.md#servicecode)
+* [serviceLevel](ims.productcontext.md#servicelevel)
+* [statusCode](ims.productcontext.md#statuscode)
+* [tenant\_id](ims.productcontext.md#tenant_id)
+
+## Properties
+
+### createDts
+
+•  **createDts**: number
+
+___
+
+### geo
+
+• `Optional` **geo**: undefined \| string
+
+___
+
+### global\_company\_id
+
+• `Optional` **global\_company\_id**: undefined \| string
+
+___
+
+### groupid
+
+•  **groupid**: string
+
+___
+
+### ident
+
+•  **ident**: string
+
+___
+
+### label
+
+•  **label**: string
+
+___
+
+### login\_company
+
+• `Optional` **login\_company**: undefined \| string
+
+___
+
+### migration\_status
+
+• `Optional` **migration\_status**: undefined \| string
+
+___
+
+### modDts
+
+•  **modDts**: number
+
+___
+
+### offer\_id
+
+• `Optional` **offer\_id**: undefined \| string
+
+___
+
+### owningEntity
+
+•  **owningEntity**: string
+
+___
+
+### serviceCode
+
+•  **serviceCode**: string
+
+___
+
+### serviceLevel
+
+•  **serviceLevel**: string
+
+___
+
+### statusCode
+
+•  **statusCode**: string
+
+___
+
+### tenant\_id
+
+• `Optional` **tenant\_id**: undefined \| string

package/docs/interfaces/ims.projectedproductcontext.md

@@ -0,0 +1,21 @@
+**[@adobe/exc-app](../README.md)**
+
+> [Globals](../README.md) / [ims](../modules/ims.md) / ProjectedProductContext
+
+# Interface: ProjectedProductContext
+
+## Hierarchy
+
+* **ProjectedProductContext**
+
+## Index
+
+### Properties
+
+* [prodCtx](ims.projectedproductcontext.md#prodctx)
+
+## Properties
+
+### prodCtx
+
+•  **prodCtx**: [ProductContext](ims.productcontext.md)

package/docs/interfaces/network.queryrequest.md

@@ -14,11 +14,13 @@ Query request interface.
 
 ### Properties
 
+* [acceptLanguage](network.queryrequest.md#acceptlanguage)
 * [appId](network.queryrequest.md#appid)
 * [data](network.queryrequest.md#data)
 * [maxRetries](network.queryrequest.md#maxretries)
 * [metadata](network.queryrequest.md#metadata)
 * [operationName](network.queryrequest.md#operationname)
+* [preferredRegion](network.queryrequest.md#preferredregion)
 * [regionEnabled](network.queryrequest.md#regionenabled)
 * [routing](network.queryrequest.md#routing)
 * [scope](network.queryrequest.md#scope)
@@ -27,6 +29,16 @@ Query request interface.
 
 ## Properties
 
+### acceptLanguage
+
+• `Optional` **acceptLanguage**: undefined \| string
+
+Set the Accept-Language HTTP header in the request. Defaults to '*' (any language).
+
+See https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language for more details.
+
+___
+
 ### appId
 
 • `Optional` **appId**: undefined \| string
@@ -91,6 +103,14 @@ Query ID- To analyze a query's metrics & performance.
 
 ___
 
+### preferredRegion
+
+• `Optional` **preferredRegion**: [GraphQLRegion](../modules/network.md#graphqlregion)
+
+Preferred region to send the GraphQL request to
+
+___
+
 ### regionEnabled
 
 • `Optional` **regionEnabled**: undefined \| false \| true

package/docs/interfaces/root.poller.md

@@ -0,0 +1,56 @@
+**[@adobe/exc-app](../README.md)**
+
+> [Globals](../README.md) / [root](../modules/root.md) / Poller
+
+# Interface: Poller
+
+## Hierarchy
+
+* **Poller**
+
+## Index
+
+### Properties
+
+* [activeFrequency](root.poller.md#activefrequency)
+* [hiddenFrequency](root.poller.md#hiddenfrequency)
+* [immediate](root.poller.md#immediate)
+* [inactiveFrequency](root.poller.md#inactivefrequency)
+* [name](root.poller.md#name)
+* [pollFn](root.poller.md#pollfn)
+
+## Properties
+
+### activeFrequency
+
+•  **activeFrequency**: number
+
+___
+
+### hiddenFrequency
+
+• `Optional` **hiddenFrequency**: undefined \| number
+
+___
+
+### immediate
+
+•  **immediate**: boolean
+
+___
+
+### inactiveFrequency
+
+•  **inactiveFrequency**: number
+
+___
+
+### name
+
+•  **name**: string
+
+___
+
+### pollFn
+
+•  **pollFn**: () => Promise<void\>

package/docs/interfaces/root.pollerhandle.md

@@ -0,0 +1,21 @@
+**[@adobe/exc-app](../README.md)**
+
+> [Globals](../README.md) / [root](../modules/root.md) / PollerHandle
+
+# Interface: PollerHandle
+
+## Hierarchy
+
+* **PollerHandle**
+
+## Index
+
+### Properties
+
+* [handle](root.pollerhandle.md#handle)
+
+## Properties
+
+### handle
+
+•  **handle**: string

package/docs/interfaces/root.pollingconfiguration.md

@@ -0,0 +1,28 @@
+**[@adobe/exc-app](../README.md)**
+
+> [Globals](../README.md) / [root](../modules/root.md) / PollingConfiguration
+
+# Interface: PollingConfiguration
+
+## Hierarchy
+
+* **PollingConfiguration**
+
+## Index
+
+### Properties
+
+* [inactivityTimeoutSec](root.pollingconfiguration.md#inactivitytimeoutsec)
+* [pollWhileInactive](root.pollingconfiguration.md#pollwhileinactive)
+
+## Properties
+
+### inactivityTimeoutSec
+
+• `Optional` **inactivityTimeoutSec**: undefined \| number
+
+___
+
+### pollWhileInactive
+
+• `Optional` **pollWhileInactive**: undefined \| false \| true

package/docs/interfaces/root.runtimeconfiguration.md

@@ -50,6 +50,7 @@ External Runtime Configuration Interface
 * [shellSideNavCollapsed](root.runtimeconfiguration.md#shellsidenavcollapsed)
 * [shellSideNavPresent](root.runtimeconfiguration.md#shellsidenavpresent)
 * [shellSideNavWidth](root.runtimeconfiguration.md#shellsidenavwidth)
+* [sourceEnvironment](root.runtimeconfiguration.md#sourceenvironment)
 * [spaAppId](root.runtimeconfiguration.md#spaappid)
 * [subOrg](root.runtimeconfiguration.md#suborg)
 * [tenant](root.runtimeconfiguration.md#tenant)
@@ -229,7 +230,7 @@ ___
 
 ### imsProfile
 
-• `Optional` **imsProfile**: undefined \| { authId: string ; displayName: string ; session: string ; userId: string  }
+• `Optional` **imsProfile**: [ImsProfile](ims.imsprofile.md)
 
 User IMS Profile
 
@@ -347,6 +348,14 @@ Side Nav width
 
 ___
 
+### sourceEnvironment
+
+•  **sourceEnvironment**: string
+
+Source environment
+
+___
+
 ### spaAppId
 
 • `Optional` **spaAppId**: undefined \| string

package/docs/interfaces/root.useractivityemitter.md

@@ -0,0 +1,110 @@
+**[@adobe/exc-app](../README.md)**
+
+> [Globals](../README.md) / [root](../modules/root.md) / UserActivityEmitter
+
+# Interface: UserActivityEmitter<T\>
+
+## Type parameters
+
+Name | Default |
+------ | ------ |
+`T` | Record<string, any\\> |
+
+## Hierarchy
+
+* EventEmitter
+
+  ↳ **UserActivityEmitter**
+
+## Index
+
+### Properties
+
+* [activityEvents](root.useractivityemitter.md#activityevents)
+
+### EventEmitter Methods
+
+* [emit](root.useractivityemitter.md#emit)
+* [off](root.useractivityemitter.md#off)
+* [on](root.useractivityemitter.md#on)
+
+## Properties
+
+### activityEvents
+
+•  **activityEvents**: string[]
+
+## EventEmitter Methods
+
+### emit
+
+▸ **emit**<K\>(`type`: K, `event?`: T[K]): void
+
+*Inherited from void*
+
+Invoke all handlers for the given type.
+
+#### Type parameters:
+
+Name | Type |
+------ | ------ |
+`K` | keyof T |
+
+#### Parameters:
+
+Name | Type | Description |
+------ | ------ | ------ |
+`type` | K | The event type to invoke. |
+`event?` | T[K] | Any value (object is recommended and powerful), passed to each handler. |
+
+**Returns:** void
+
+___
+
+### off
+
+▸ **off**<K\>(`type`: K, `handler`: (event?: T[K]) => void): void
+
+*Inherited from void*
+
+Remove an event handler for the given type.
+
+#### Type parameters:
+
+Name | Type |
+------ | ------ |
+`K` | keyof T |
+
+#### Parameters:
+
+Name | Type | Description |
+------ | ------ | ------ |
+`type` | K | Type of event to unregister `handler` from. |
+`handler` | (event?: T[K]) => void | Handler function to remove. |
+
+**Returns:** void
+
+___
+
+### on
+
+▸ **on**<K\>(`type`: K, `handler`: (event?: T[K]) => void): void
+
+*Inherited from void*
+
+Register an event handler for the given type.
+
+#### Type parameters:
+
+Name | Type |
+------ | ------ |
+`K` | keyof T |
+
+#### Parameters:
+
+Name | Type | Description |
+------ | ------ | ------ |
+`type` | K | Type of event to listen for. |
+`handler` | (event?: T[K]) => void | Function to call in response to given event. |
+
+**Returns:** void

package/docs/interfaces/root.useractivitymonitor.md

@@ -0,0 +1,151 @@
+**[@adobe/exc-app](../README.md)**
+
+> [Globals](../README.md) / [root](../modules/root.md) / UserActivityMonitor
+
+# Interface: UserActivityMonitor<T\>
+
+## Type parameters
+
+Name | Default |
+------ | ------ |
+`T` | Record<string, any\\> |
+
+## Hierarchy
+
+* EventEmitter
+
+  ↳ **UserActivityMonitor**
+
+## Index
+
+### Properties
+
+* [active](root.useractivitymonitor.md#active)
+* [configure](root.useractivitymonitor.md#configure)
+* [hidden](root.useractivitymonitor.md#hidden)
+* [lastActive](root.useractivitymonitor.md#lastactive)
+
+### EventEmitter Methods
+
+* [emit](root.useractivitymonitor.md#emit)
+* [off](root.useractivitymonitor.md#off)
+* [on](root.useractivitymonitor.md#on)
+
+### Other Methods
+
+* [registerActivityEmitter](root.useractivitymonitor.md#registeractivityemitter)
+
+## Properties
+
+### active
+
+•  **active**: boolean
+
+___
+
+### configure
+
+•  **configure**: (config: [PollingConfiguration](root.pollingconfiguration.md)) => void
+
+___
+
+### hidden
+
+•  **hidden**: boolean
+
+___
+
+### lastActive
+
+•  **lastActive**: number
+
+## EventEmitter Methods
+
+### emit
+
+▸ **emit**<K\>(`type`: K, `event?`: T[K]): void
+
+*Inherited from void*
+
+Invoke all handlers for the given type.
+
+#### Type parameters:
+
+Name | Type |
+------ | ------ |
+`K` | keyof T |
+
+#### Parameters:
+
+Name | Type | Description |
+------ | ------ | ------ |
+`type` | K | The event type to invoke. |
+`event?` | T[K] | Any value (object is recommended and powerful), passed to each handler. |
+
+**Returns:** void
+
+___
+
+### off
+
+▸ **off**<K\>(`type`: K, `handler`: (event?: T[K]) => void): void
+
+*Inherited from void*
+
+Remove an event handler for the given type.
+
+#### Type parameters:
+
+Name | Type |
+------ | ------ |
+`K` | keyof T |
+
+#### Parameters:
+
+Name | Type | Description |
+------ | ------ | ------ |
+`type` | K | Type of event to unregister `handler` from. |
+`handler` | (event?: T[K]) => void | Handler function to remove. |
+
+**Returns:** void
+
+___
+
+### on
+
+▸ **on**<K\>(`type`: K, `handler`: (event?: T[K]) => void): void
+
+*Inherited from void*
+
+Register an event handler for the given type.
+
+#### Type parameters:
+
+Name | Type |
+------ | ------ |
+`K` | keyof T |
+
+#### Parameters:
+
+Name | Type | Description |
+------ | ------ | ------ |
+`type` | K | Type of event to listen for. |
+`handler` | (event?: T[K]) => void | Function to call in response to given event. |
+
+**Returns:** void
+
+___
+
+## Other Methods
+
+### registerActivityEmitter
+
+▸ **registerActivityEmitter**(`emitter`: [UserActivityEmitter](root.useractivityemitter.md)): void
+
+#### Parameters:
+
+Name | Type |
+------ | ------ |
+`emitter` | [UserActivityEmitter](root.useractivityemitter.md) |
+
+**Returns:** void

package/docs/interfaces/user.userapi.md

@@ -32,7 +32,7 @@
 
 ### logoutUrl
 
-•  **logoutUrl**: string \| undefined
+• `Optional` **logoutUrl**: [LogoutUrl](../modules/user.md#logouturl)
 
 Optional. When specified this URL will be invoked upon user logging out. This is useful to
 reduce the number of lingering sessions for solutions who have their own sessions server

package/docs/modules/ims.md

@@ -0,0 +1,14 @@
+**[@adobe/exc-app](../README.md)**
+
+> [Globals](../README.md) / ims
+
+# Module: ims
+
+## Index
+
+### Interfaces
+
+* [ActiveProductContext](../interfaces/ims.activeproductcontext.md)
+* [ImsProfile](../interfaces/ims.imsprofile.md)
+* [ProductContext](../interfaces/ims.productcontext.md)
+* [ProjectedProductContext](../interfaces/ims.projectedproductcontext.md)

package/docs/modules/network.md

@@ -63,6 +63,7 @@ const queryResponse = await query({
 ### Type aliases
 
 * [FetchInit](network.md#fetchinit)
+* [GraphQLRegion](network.md#graphqlregion)
 
 ### Variables
 
@@ -89,6 +90,12 @@ also additionally specify the 'auth' parameter to automatically set the Authenti
 `{auth: 'Header', method: 'GET'}` or
 `{method: 'GET'}`
 
+___
+
+### GraphQLRegion
+
+Ƭ  **GraphQLRegion**: \"va7\" \| \"aus5\" \| \"nld2\"
+
 ## Variables
 
 ### DEFAULT\_STATUS\_CODES\_TO\_RETRY

package/docs/modules/root.md

@@ -16,8 +16,13 @@ Cloud.
 ### Interfaces
 
 * [Modules](../interfaces/root.modules.md)
+* [Poller](../interfaces/root.poller.md)
+* [PollerHandle](../interfaces/root.pollerhandle.md)
+* [PollingConfiguration](../interfaces/root.pollingconfiguration.md)
 * [Runtime](../interfaces/root.runtime.md)
 * [RuntimeConfiguration](../interfaces/root.runtimeconfiguration.md)
+* [UserActivityEmitter](../interfaces/root.useractivityemitter.md)
+* [UserActivityMonitor](../interfaces/root.useractivitymonitor.md)
 
 ### Functions