@adobe/exc-app 0.2.45 → 1.0.0

package/capabilityapi.ts

@@ -1,162 +0,0 @@
-/*************************************************************************
- * 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.
- **************************************************************************/
-
-/**
- * API to request capability icons by id (or secondarily by display name).
- *
- * ***Import:***
- *
- * ```typescript
- * import capabilityApi from '@adobe/exc-app/capabilityapi';
- * ```
- *
- * ***Default export:***
- *
- * [CapabilityApi](../interfaces/capability.capabilityapi.md#interface-capabilityapi)
- *
- * ***Usage:***
- * These APIs return promises, not properties, and will need to be
- * asynchronously loaded by calling `get`.
- *
- * ```typescript
- * const [home, assets, offer] = await Promise.all([
- *   capabilityApi.get('home'),
- *   capabilityApi.get('assets'),
- *   capabilityApi.get('offer')
- * ]);
- *
- * ```
- *
- * API for fetching capability icon data.
- * @packageDocumentation
- * @module capabilityapi
- */
-
-import {getImpl} from './src/Global';
-
-export interface CapabilityResponse {
-  /**
-   * Unique key to identify the capability.
-   */
-  capabilityId: string;
-  /**
-   * A URL to fetch the capability's icon.
-   */
-  iconUrl: string;
-}
-
-// This list is dynamically generated in preBuild
-export enum CapabilityNames {
-  ACCOUNTPROFILE = 'Profiles',
-  ADMIN = 'Configurations',
-  ALERT = 'Alerts',
-  APPCONFIGURATIONS = 'App Configurations',
-  APPLICATIONS = 'Applications',
-  APPSURFACES = 'App Surfaces',
-  ASSETS = 'Assets',
-  CLIENTPROPERTIES = 'Tags',
-  COMPONENTS = 'Components',
-  DASHBOARD = 'Dashboards',
-  DATAFLOW = 'Dataflows',
-  DATASET = 'Datasets',
-  DATASTREAMS = 'Datastreams',
-  DATASTREAMSBETA = 'Datastreams (Beta)',
-  DESTINATION = 'Destinations',
-  HOME = 'Home',
-  IDENTITIES = 'Identities',
-  IDENTITY = 'Identities',
-  JOURNEYS = 'Journeys',
-  LANDINGPAGES = 'Landing pages',
-  LICENSEUSAGE = 'License Usage',
-  MESSAGES = 'Messages',
-  MODEL = 'Models',
-  MONITORING = 'Monitoring',
-  NOTEBOOK = 'Notebooks',
-  OFFER = 'Offers',
-  OFFERACTIVITY = 'Components',
-  POLICY = 'Policies',
-  PRIVACYAUDIT = 'Audits',
-  PROFILE = 'Profiles',
-  QUERY = 'Queries',
-  REQUEST = 'Requests',
-  RULESPOLICIES = 'Rules & policies',
-  SANDBOX = 'Sandboxes',
-  SCHEMA = 'Schemas',
-  SEGMENT = 'Segments',
-  SERVERPROPERTIES = 'Event Forwarding',
-  SERVICE = 'Services',
-  SETTINGS = 'Channels',
-  SOURCE = 'Sources',
-  SUBSCRIPTIONS = 'Subscription list',
-  WORKFLOW = 'Workflows'
-}
-
-// This list is dynamically generated in preBuild
-export enum CapabilityIds {
-  ACCOUNTPROFILE = 'accountProfile',
-  ADMIN = 'admin',
-  ALERT = 'alert',
-  APPCONFIGURATIONS = 'appconfigurations',
-  APPLICATIONS = 'applications',
-  APPSURFACES = 'appsurfaces',
-  ASSETS = 'assets',
-  CLIENTPROPERTIES = 'clientproperties',
-  COMPONENTS = 'components',
-  DASHBOARD = 'dashboard',
-  DATAFLOW = 'dataflow',
-  DATASET = 'dataset',
-  DATASTREAMS = 'datastreams',
-  DATASTREAMSBETA = 'datastreamsbeta',
-  DESTINATION = 'destination',
-  HOME = 'home',
-  IDENTITIES = 'identities',
-  IDENTITY = 'identity',
-  JOURNEYS = 'journeys',
-  LANDINGPAGES = 'landingPages',
-  LICENSEUSAGE = 'licenseUsage',
-  MESSAGES = 'messages',
-  MODEL = 'model',
-  MONITORING = 'monitoring',
-  NOTEBOOK = 'notebook',
-  OFFER = 'offer',
-  OFFERACTIVITY = 'offeractivity',
-  POLICY = 'policy',
-  PRIVACYAUDIT = 'privacyAudit',
-  PROFILE = 'profile',
-  QUERY = 'query',
-  REQUEST = 'request',
-  RULESPOLICIES = 'rulesPolicies',
-  SANDBOX = 'sandbox',
-  SCHEMA = 'schema',
-  SEGMENT = 'segment',
-  SERVERPROPERTIES = 'serverproperties',
-  SERVICE = 'service',
-  SETTINGS = 'settings',
-  SOURCE = 'source',
-  SUBSCRIPTIONS = 'subscriptions',
-  WORKFLOW = 'workflow'
-}
-
-export interface CapabilityApi {
-  /**
-   * Gets the specified icon.
-   * @param icon The name of the capability, solution, or other to get an icon for.
-   */
-  get(capability: CapabilityNames | CapabilityIds): Promise<CapabilityResponse>;
-}
-
-const capabilityapi = {
-  get: params => {
-    return getImpl('capabilityApi')().get(params);
-  }
-} as CapabilityApi;
-
-export default capabilityapi;

package/helpcenter.ts

@@ -1,253 +0,0 @@
-/*************************************************************************
- * 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.
- **************************************************************************/
-/**
- * APIs that let solutions interact with Help Center.
- *
- * ***Import:***
- *
- * ```typescript
- * import helpCenter from '@adobe/exc-app/helpcenter';
- * ```
- *
- * ***Default export:***
- *
- * [HelpCenterApi](../interfaces/helpcenter.helpcenterapi.md#interface-helpcenterapi)
- *
- * ***Usage:***
- *
- * ```typescript
- * import helpCenter from '@adobe/exc-app/helpcenter';
- *
- * helpCenter.config = {
- *   resources: [
- *     {
- *       href: 'https://marketing.adobe.com/resources/help/en_US/home/index.html',
- *       label: 'Help Home'
- *     }
- *   ]
- * };
- * ```
- * @packageDocumentation
- * @module helpCenter
- */
-import {connect} from './src/Global';
-
-export interface HelpCenterConfig {
-  /**
-   * Adds help links to the *featured* section of the help center.
-   */
-  featured?: Array<{
-    /**
-     * URL for the link to go to.
-     */
-    href: string;
-    /**
-     * Title for the link.
-     */
-    label: string;
-    /**
-     * Pattern to define path(s) the link can navigate to. The value is not regex but a Path-to-RegExp form.
-     */
-    path: string | Array<string>;
-  }>;
-  /**
-   * Customizes *for you* section of the help center.
-   */
-  recommendations?: {
-    /**
-     * Used to disable feature. It is enabled by default.
-     */
-    enabled: boolean;
-    /**
-     * Help center populates "For You" content by conducting a search against Experience League based on a list of terms supplied.
-     */
-    terms: Array<{
-      /**
-       * Pattern to define path(s) the link can navigate to. Please note that the most general ones should come last.
-       */
-      path: string;
-      /**
-       * Specific term used in searching.
-       */
-      term: string;
-    }>;
-  };
-  /**
-   * Overrides default links present in *resources* section. Product owners are advised to supply custom resources links to ensure greater relevance.
-   */
-  resources?: Array<{
-    /**
-     * URL of the link.
-     */
-    href: string;
-    /**
-     * Title for the link.
-     */
-    label: string;
-  }>;
-  /**
-   * If the solution wants to simulate "Frequently asked questions", it can provide them as an array of strings. These appear as the user starts typing in the Search field.
-   */
-  questions?: Array<string>;
-}
-
-export interface HelpCenterOpenConfig {
-  /**
-   * Configuration for Help Center fields when opened.
-   */
-  config?: {
-    /**
-     * String that prepopulates the subject field in the Help center feedback section.
-     */
-    subject: string;
-    /**
-     * Type of feedback. Only CONTEXTUAL_FEEDBACK_SUBMISSION is supported, meaning that the Help Center feedback tab will be opened.
-     */
-    type: 'CONTEXTUAL_FEEDBACK_SUBMISSION';
-  };
-  /**
-   * Selected Help Center Tab.
-   */
-  selectedTab: 'feedback' | 'support';
-}
-
-export interface HelpCenterButtonConfig {
-  /**
-   * Callback function to be automatically executed on click.
-   */
-  callback?: (value?: any) => void;
-  /**
-   * ID of the string to use for handling callback.
-   */
-  id?: string;
-  /**
-   * Text of the button.
-   */
-  label: string;
-  /**
-   * Scope of the button. Options are:
-   * 1. helpCenter: Shows as a button in the support section.
-   * 2. helpCenterResource: Shows at the bottom of the resources section.
-   */
-  scope?: string;
-}
-
-export interface HelpCenterApiProperties {
-  /**
-   * Gets or sets the configuration for Help Center.
-   *
-   * ```typescript
-   * helpCenter.config = {
-   *   featured: [
-   *     {
-   *       href: 'https://helpx.adobe.com/support/experience-cloud.html',
-   *       label: 'Adobe Experience Cloud Learn & Support',
-   *       path: '/:orgId?/home'
-   *     },
-   *     {
-   *       href: 'https://helpx.adobe.com/support/target.html',
-   *       label: 'Adobe Target'
-   *     }
-   *   ],
-   *   recommendations: {
-   *     enabled: true,
-   *     terms: [
-   *       {
-   *         path: '/:orgId?/analytics/home/(.*)?',
-   *         term: 'get started'
-   *       },
-   *       {
-   *         path: '/:orgId?/analytics/create',
-   *         term: 'create new'
-   *       }
-   *     ]
-   *   },
-   *   resources: [
-   *     {
-   *       href: 'https://marketing.adobe.com/resources/help/en_US/home/index.html',
-   *       label: 'Help Home'
-   *     }
-   *   ]
-   * };
-   * ```
-   */
-  config: HelpCenterConfig;
-}
-
-/**
- * Defines helpCenter-level APIs available to solutions.
- */
-export interface HelpCenterApi extends HelpCenterApiProperties {
-  /**
-   * Method to open the help center from within the iframe.
-   *
-   * ```typescript
-   * helpCenter.open({
-   *   config: {
-   *     subject: 'Analytics'
-   *     type: 'CONTEXTUAL_FEEDBACK_SUBMISSION'
-   *   },
-   *   selectedTab: 'feedback'
-   * });
-   * ```
-   */
-  open(config?: HelpCenterOpenConfig): void;
-
-  /**
-   * Method to close the help center from within the iframe.
-   *
-   * ```typescript
-   * helpCenter.close();
-   * ```
-   */
-  close(): void;
-
-  /**
-   * Adds a custom button to the help center and enacts a callback onclick.
-   * The button will be present under the support tab in help center.
-   * The help center button may be reset by entering a null parameter.
-   *
-   * ```typescript
-   * helpCenter.setButton({
-   *   callback: () => {},
-   *   label: 'Create Support Ticket'
-   * });
-   * ```
-   */
-  setButton(config: HelpCenterButtonConfig | HelpCenterButtonConfig[] | null): void;
-
-  /**
-   * Adds 1-many custom buttons to the help center and enacts a callback onclick.
-   * Depending on the scope (helpCenter or helpCenterResource), the buttons will
-   * be present under the support tab (helpCenter) or at the button of the
-   * resources section on the main tab (helpCenterResource) in help center.
-   * The help center button may be reset by entering a null parameter.
-   *
-   * ```typescript
-   * helpCenter.setButtons([{
-   *   callback: () => {},
-   *   id: 'support',
-   *   label: 'Create Support Ticket',
-   *   scope: 'helpCenter'
-   * }]);
-   * ```
-   */
-  setButtons(buttons: HelpCenterButtonConfig[] | null): void;
-}
-
-const helpCenter = connect('helpCenter', [
-  ['setButton', true],
-  ['setButtons', true],
-  ['config'],
-  ['open', true]
-]);
-
-export default helpCenter;

package/ims/ImsProfile.ts

@@ -1,57 +0,0 @@
-/*************************************************************************
- * 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.
- **************************************************************************/
-
-export interface ProductContext {
-  createDts: number;
-  geo?: string;
-  global_company_id?: string; // dma_analytics
-  groupid: string;
-  ident: string;
-  label: string;
-  login_company?: string;
-  migration_status?: string;
-  modDts: number;
-  offer_id?: string;
-  owningEntity: string;
-  serviceCode: string;
-  serviceLevel: string;
-  statusCode: string;
-  tenant_id?: string; // dma_tartan
-  [key: string]: any;
-}
-
-export interface ActiveProductContext {
-  [serviceCode: string]: ProductContext;
-}
-
-export interface ProjectedProductContext {
-  prodCtx: ProductContext
-}
-
-export interface ImsProfile {
-  account_type: string;
-  authId: string;
-  avatar?: string;
-  avatarSrc?: string;
-  countryCode: string;
-  displayName: string;
-  email: string;
-  emailVerified: boolean;
-  first_name: string;
-  job_function: string;
-  last_name: string;
-  name: string;
-  preferred_languages: string[];
-  projectedProductContext: ProjectedProductContext[];
-  session: string;
-  userId: string;
-  [key: string]: any;
-}

package/index.ts

@@ -1,76 +0,0 @@
-/*************************************************************************
- * 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 integrate as solution web application with the unified shell of the Adobe Experience
- * Cloud.
- * @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.
- *
- * ***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 The runtime object.
- */
-export default function runtime(): Runtime {
-  // Pass through first argument for backwards compatibility
-  return getImpl('default')(arguments[0]); // eslint-disable-line prefer-rest-params
-}
-
-/**
- * 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'));
- * });
- * ```
- * @param bootstrap Callback used to bootstrap a solution. The runtime object is passed in as a
- * parameter to this callback.
- */
-export function init(bootstrap: (runtime: Runtime) => void): void {
-  const callback = (): void => {
-    bootstrap(runtime());
-  };
-  if (Global['exc-module-runtime']) {
-    callback();
-  } else {
-    Global.EXC_MR_READY = callback;
-  }
-}
-
-export type {Runtime};

package/internal.ts

@@ -1,102 +0,0 @@
-/*************************************************************************
- * 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.
- **************************************************************************/
-
-/**
- * Internal APIs, meant to be used by Unified Shell only.
- * @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';
-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;
-}
-
-/**
- * @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);
-  }
-  public static setFilter(filterFunction: <T>(record: T) => Promise<T>): void {
-    return getImpl('internal').setFilter(filterFunction);
-  }
-  public static setUser(user: User, version?: string): void {
-    return getImpl('internal').setUser(user, version);
-  }
-  public static clearUser(version?: string): void {
-    return getImpl('internal').clearUser(version);
-  }
-}
-

package/metrics/Analytics.ts

@@ -1,55 +0,0 @@
-/*************************************************************************
- * 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.
- **************************************************************************/
-
-/**
- * @packageDocumentation
- * @module metrics
- */
-
-/**
- * The Analytics APIs are designed to mirror the Omega APIs, enabling an Analtyics record to be
- * remotely stored which simulatenously captures additional context provided by the Metrics system
- * at the same time that window.digitalData is sent to analytics. Two use cases are supported,
- * described as follows.
- *
- * For applications that provide Omega launch script configuration to the
- * `MetricsBrowserRuntime.init()` method, the corresponding portions of the digitalData object can
- * be supplied to the following APIs, and the Metrics SDK will store the provided object in
- * `window.digitalData`, and simultaneously record the Analytics record in remote storage and call
- * the Omega `window._satellite.track()` method. This approach assures consistency in the data
- * between Omega and Metrics.
- */
-export default interface Analytics {
-  /**
-   * Complements the corresponding window._satellite.track() method and records an Analytics record.
-   * @param type The type of event.
-   * @param args Additional data to log.
-   */
-  track(type: 'event' | 'page' | 'user', ...args: any): void;
-
-  /**
-   * Set `window.digialData.eventData` to the specified input and record an Analytics record.
-   * @param event The object to assign to `window.digitalData.eventData`.
-   */
-  trackEvent(eventData: Record<string, any>): void;
-
-  /**
-   * Set `window.digialData.pageData` to the specified input and record an Analytics record.
-   * @param pageData The object to assign to `window.digitalData.pageData`.
-   */
-  trackPage(pageData: Record<string, any>): void;
-
-  /**
-   * Set `window.digialData.userData` to the specified input and record an Analytics record.
-   * @param userData The object to assign to `window.digitalData.userData`.
-   */
-  trackUser(userData: Record<string, any>): void;
-}