@adobe/exc-app 0.2.41 → 0.2.42

package/RuntimeConfiguration.d.ts

@@ -0,0 +1,257 @@
+/*************************************************************************
+ * 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.
+ **************************************************************************/
+import type MetricsConfiguration from './metrics/Configuration';
+/**
+ * ImsOrg Interface
+ */
+interface ImsOrg {
+    /**
+     * ImsOrg Name - Label
+     */
+    label: string;
+    /**
+     * ImsOrg ID - Value
+     */
+    value: string;
+}
+/**
+ * ImsOrg Interface
+ */
+interface ImsInfo {
+    /**
+     * ImsOrg - ID
+     */
+    imsOrg?: string;
+    /**
+     * ImsOrg Name - Label
+     */
+    imsOrgName?: string;
+    /**
+     * ImsOrg Profile
+     */
+    imsProfile?: Record<string, any>;
+    /**
+     * ImsToken
+     */
+    imsToken?: string;
+    /**
+     * locale
+     */
+    locale?: string;
+    /**
+     * tenant
+     */
+    tenant?: string;
+}
+/**
+ * User Sandbox Interface
+ */
+interface Sandbox {
+    /**
+     * Whether it is the default sandbox
+     */
+    isDefault: boolean;
+    /**
+     * Sandbox ID
+     */
+    name: string;
+    /**
+     * Region
+     */
+    region: string;
+    /**
+     * Current state
+     */
+    state: string;
+    /**
+     * Sandbox Display Title
+     */
+    title: string;
+    /**
+     * Environment type
+     */
+    type: string;
+}
+/**
+ * External Runtime Configuration Interface
+ */
+export interface RuntimeConfiguration {
+    /**
+     * OMEGA Launch script properties
+     */
+    analytics?: {
+        /**
+         * OMEGA script for respective env
+         */
+        script: string;
+        /**
+         * solution specific OMEGA code
+         */
+        solution: string;
+    };
+    /**
+     * App Container
+     */
+    appContainer: string;
+    /**
+     * Solution appId
+     */
+    appId: string;
+    /**
+     * Unified Shell API Gateway URL
+     */
+    apiGatewayUrl: string;
+    /**
+     * Solution iframe src url
+     */
+    baseFrameUrl: string;
+    /**
+     * Base URL
+     */
+    baseUrl: string;
+    /**
+     * List all properties changed in this configuration compared to the previous one sent
+     */
+    changedProperties: (keyof RuntimeConfiguration)[];
+    /**
+     * If discovery URL
+     */
+    discovery: boolean;
+    /**
+     * Unified Shell's environment
+     */
+    environment: string;
+    /**
+     * Query params
+     */
+    externalQueryParams: string;
+    /**
+     * Gainsight configuration.
+     */
+    gainsight?: {
+        enabled: boolean;
+        productKey: string;
+    };
+    /**
+     * Solution History type
+     */
+    historyType: 'HASH' | 'HISTORY' | 'SERVER';
+    /**
+     * Solution's list of multiple subdomains
+     */
+    hosts?: string[];
+    /**
+     * IMS Client ID
+     */
+    imsClientId: string;
+    /**
+     * IMS Information
+     */
+    imsInfo: ImsInfo;
+    /**
+     * Current IMS Org ID
+     */
+    imsOrg: string;
+    /**
+     * ImsOrg Interface
+     */
+    imsOrgs: Array<Record<string, ImsOrg>>;
+    /**
+     * Current IMS Org Name
+     */
+    imsOrgName: string;
+    /**
+     * User IMS Profile
+     */
+    imsProfile?: {
+        authId: string;
+        displayName: string;
+        session: string;
+        userId: string;
+    };
+    /**
+     * IMS Token
+     */
+    imsToken: string;
+    /**
+     * User Locale
+     */
+    locale: string;
+    /**
+     * Solution metricsAppId
+     */
+    metricsAppId?: string;
+    /**
+     * AdobeMetricsRuntime Configuration
+     */
+    metricsConfig: MetricsConfiguration;
+    /**
+     * Metrics environment (may differ from environment)
+     */
+    metricsEnv?: string;
+    /**
+     * Current Sandbox
+     */
+    sandbox?: Sandbox;
+    /**
+     * Shell Height
+     */
+    shellHeight: number;
+    /**
+     * Shell Info
+     */
+    shellInfo?: Record<string, any>;
+    /**
+     * Is Side Nav collapsed?
+     */
+    shellSideNavCollapsed?: boolean;
+    /**
+     * Is Side Nav enabled?
+     */
+    shellSideNavPresent: boolean;
+    /**
+     * Side Nav width
+     */
+    shellSideNavWidth: number;
+    /**
+     * SPA pipeline app id
+     */
+    spaAppId?: string;
+    /**
+     * Sub Org
+     */
+    subOrg?: Record<string, any>;
+    /**
+     * Tenant ID
+     */
+    tenant: string;
+    /**
+     * @deprecated Solution GraphQL tenantAppId
+     */
+    tenantAppId?: string;
+    /**
+     * Adobe IO gateway URL used as a fallback in GQL call
+     */
+    ioGatewayUrl?: string;
+    /**
+     * Map of Adobe Io region specific endpoints.
+     */
+    ioRegionSpecificMap?: Record<string, string>;
+    /**
+     * Clients can pass in their local GQL endpoint
+     */
+    gqlEndpoint?: string;
+    /**
+     * XQL gateway used for AEP specific queries
+     */
+    xqlGatewayUrl?: string;
+}
+export {};

package/RuntimeConfiguration.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=RuntimeConfiguration.js.map

package/RuntimeConfiguration.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"RuntimeConfiguration.js","sourceRoot":"","sources":["RuntimeConfiguration.ts"],"names":[],"mappings":""}

package/RuntimeConfiguration.ts

@@ -0,0 +1,260 @@
+/*************************************************************************
+ * 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.
+ **************************************************************************/
+import type MetricsConfiguration from './metrics/Configuration';
+
+/**
+ * ImsOrg Interface
+ */
+interface ImsOrg {
+  /**
+   * ImsOrg Name - Label
+   */
+  label: string;
+  /**
+   * ImsOrg ID - Value
+   */
+  value: string;
+}
+
+/**
+ * ImsOrg Interface
+ */
+interface ImsInfo {
+  /**
+   * ImsOrg - ID
+   */
+  imsOrg?: string;
+  /**
+   * ImsOrg Name - Label
+   */
+  imsOrgName?: string;
+  /**
+   * ImsOrg Profile
+   */
+  imsProfile?: Record<string, any>;
+  /**
+   * ImsToken
+   */
+  imsToken?: string;
+  /**
+   * locale
+   */
+  locale?: string;
+  /**
+   * tenant
+   */
+  tenant?: string;
+}
+
+/**
+ * User Sandbox Interface
+ */
+interface Sandbox {
+  /**
+   * Whether it is the default sandbox
+   */
+  isDefault: boolean;
+  /**
+   * Sandbox ID
+   */
+  name: string;
+  /**
+   * Region
+   */
+  region: string;
+  /**
+   * Current state
+   */
+  state: string;
+  /**
+   * Sandbox Display Title
+   */
+  title: string;
+  /**
+   * Environment type
+   */
+  type: string;
+}
+
+/**
+ * External Runtime Configuration Interface
+ */
+export interface RuntimeConfiguration {
+  /**
+   * OMEGA Launch script properties
+   */
+  analytics?: {
+    /**
+     * OMEGA script for respective env
+     */
+    script: string;
+    /**
+     * solution specific OMEGA code
+     */
+    solution: string;
+  };
+  /**
+   * App Container
+   */
+  appContainer: string;
+  /**
+   * Solution appId
+   */
+  appId: string;
+  /**
+   * Unified Shell API Gateway URL
+   */
+  apiGatewayUrl: string;
+  /**
+   * Solution iframe src url
+   */
+  baseFrameUrl: string;
+  /**
+   * Base URL
+   */
+  baseUrl: string;
+  /**
+   * List all properties changed in this configuration compared to the previous one sent
+   */
+  changedProperties: (keyof RuntimeConfiguration)[],
+  /**
+   * If discovery URL
+   */
+  discovery: boolean;
+  /**
+   * Unified Shell's environment
+   */
+  environment: string;
+  /**
+   * Query params
+   */
+  externalQueryParams: string;
+  /**
+   * Gainsight configuration.
+   */
+  gainsight?: {
+    enabled: boolean;
+    productKey: string;
+  };
+  /**
+   * Solution History type
+   */
+  historyType: 'HASH' | 'HISTORY' | 'SERVER';
+  /**
+   * Solution's list of multiple subdomains
+   */
+  hosts?: string[];
+  /**
+   * IMS Client ID
+   */
+  imsClientId: string;
+  /**
+   * IMS Information
+   */
+  imsInfo: ImsInfo;
+  /**
+   * Current IMS Org ID
+   */
+  imsOrg: string;
+  /**
+   * ImsOrg Interface
+   */
+  imsOrgs: Array<Record<string, ImsOrg>>;
+  /**
+   * Current IMS Org Name
+   */
+  imsOrgName: string;
+  /**
+   * User IMS Profile
+   */
+  imsProfile?: {
+    authId: string;
+    displayName: string;
+    session: string;
+    userId: string;
+  };
+  /**
+   * IMS Token
+   */
+  imsToken: string;
+  /**
+   * User Locale
+   */
+  locale: string;
+  /**
+   * Solution metricsAppId
+   */
+  metricsAppId?: string;
+  /**
+   * AdobeMetricsRuntime Configuration
+   */
+  metricsConfig: MetricsConfiguration;
+  /**
+   * Metrics environment (may differ from environment)
+   */
+  metricsEnv?: string;
+  /**
+   * Current Sandbox
+   */
+  sandbox?: Sandbox;
+  /**
+   * Shell Height
+   */
+  shellHeight: number;
+  /**
+   * Shell Info
+   */
+  shellInfo?: Record<string, any>;
+  /**
+   * Is Side Nav collapsed?
+   */
+  shellSideNavCollapsed?: boolean;
+  /**
+   * Is Side Nav enabled?
+   */
+  shellSideNavPresent: boolean;
+  /**
+   * Side Nav width
+   */
+  shellSideNavWidth: number;
+  /**
+   * SPA pipeline app id
+   */
+  spaAppId?: string;
+  /**
+   * Sub Org
+   */
+  subOrg?: Record<string, any>;
+  /**
+   * Tenant ID
+   */
+  tenant: string;
+  /**
+   * @deprecated Solution GraphQL tenantAppId
+   */
+  tenantAppId?: string;
+  /**
+   * Adobe IO gateway URL used as a fallback in GQL call
+   */
+  ioGatewayUrl?: string;
+  /**
+   * Map of Adobe Io region specific endpoints.
+   */
+  ioRegionSpecificMap?: Record<string, string>;
+  /**
+   * Clients can pass in their local GQL endpoint
+   */
+  gqlEndpoint?: string;
+  /**
+   * XQL gateway used for AEP specific queries
+   */
+  xqlGatewayUrl?: string;
+}

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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/exc-app",
-  "version": "0.2.41",
+  "version": "0.2.42",
   "main": "index.js",
   "source": "index.ts",
   "scripts": {