@adobe/exc-app 0.2.46 → 1.0.1

package/tests/sidenav.test.ts

@@ -1,91 +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.
- **************************************************************************/
-import Global, {Modules} from '../src/Global';
-import sidenav, {SidenavApi, SidenavInfo} from '../sidenav';
-
-describe('sidenav.ts', () => {
-  const evt = true;
-  const handler = () => {};
-  const sidenavMock = {
-    collapsed: true,
-    emit: (type, evt) => {
-      return {evt, type};
-    },
-    get: (param: SidenavInfo) => {
-      return Promise.resolve(param);
-    },
-    off: (type, handler) => {
-      return {handler, type};
-    },
-    on: (type, handler) => {
-      return {handler, type};
-    },
-    visible: true
-  } as SidenavApi;
-
-  beforeEach(() => {
-    (Global['exc-module-runtime'] as Modules) = {
-      sidenav: () => {
-        return sidenavMock;
-      }
-    } as Modules;
-  });
-
-  it('can emit()', () => {
-    const spy = jest.spyOn(sidenavMock, 'emit');
-
-    // action
-    sidenav.emit('change:shellSideNavCollapsed', evt),
-
-    // verify
-    expect(spy).toBeCalledTimes(1);
-    expect(spy).toBeCalledWith('change:shellSideNavCollapsed', evt);
-  });
-
-  it('can get()', async () => {
-    const spy = jest.spyOn(sidenavMock, 'get');
-
-    // action
-    await Promise.all([
-      sidenav.get('shellSideNavCollapsed')
-    ]);
-
-    // verify
-    expect(spy).toBeCalledTimes(1);
-    expect(spy).toBeCalledWith('shellSideNavCollapsed');
-
-    // verify getters
-    expect(sidenav.collapsed).toEqual(true);
-    expect(sidenav.visible).toEqual(true);
-  });
-
-  it('can off()', () => {
-    const spy = jest.spyOn(sidenavMock, 'off');
-
-    // action
-    sidenav.off('change:shellSideNavCollapsed', handler),
-
-    // verify
-    expect(spy).toBeCalledTimes(1);
-    expect(spy).toBeCalledWith('change:shellSideNavCollapsed', handler);
-  });
-
-  it('can on()', () => {
-    const spy = jest.spyOn(sidenavMock, 'on');
-
-    // action
-    sidenav.on('change:shellSideNavCollapsed', handler);
-
-    // verify
-    expect(spy).toBeCalledTimes(1);
-    expect(spy).toBeCalledWith('change:shellSideNavCollapsed', handler);
-  });
-});

package/tests/topbar.test.ts

@@ -1,85 +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.
- **************************************************************************/
-import Global, {Modules} from '../src/Global';
-import topbar, {
-  Callback,
-  CustomFeedbackConfig,
-  CustomSearchConfig,
-  ExternalFeedbackConfig,
-  HelpCenterFeedbackConfig
-} from '../topbar';
-
-describe('topbar/index.js', () => {
-  beforeEach(() => {
-    (Global['exc-module-runtime'] as Modules) = {
-      topbar: {
-        customEnvLabel: 'Test',
-        onHeroClick: (callback: Callback) => {
-          console.log(callback); // eslint-disable-line no-console
-        },
-        setCustomSearch: (config: CustomSearchConfig) => {
-          console.log(config); // eslint-disable-line no-console
-        },
-        setFeedbackButton: (config: CustomFeedbackConfig | HelpCenterFeedbackConfig | ExternalFeedbackConfig | null) => {
-          console.log(config); // eslint-disable-line no-console
-        },
-        solution: {
-          icon: 'AdobeExperienceCloud',
-          shortTitle: 'AEC',
-          title: 'Adobe Experience Cloud22'
-        },
-        workspaces: [{name: 'Workspace', url: '/workspace'}]
-      }
-    } as Modules;
-  });
-
-  it('correctly sets up the connection with module-runtime', () => {
-    expect(true).toEqual(true);
-    const searchCallback = jest.fn();
-    const setCustomSearchSpy = jest.spyOn(Global['exc-module-runtime'].topbar, 'setCustomSearch');
-    topbar.setCustomSearch({callback: searchCallback, enabled: true, open: false});
-    expect(setCustomSearchSpy).toBeCalledTimes(1);
-
-    expect(topbar.solution).toStrictEqual({
-      icon: 'AdobeExperienceCloud',
-      shortTitle: 'AEC',
-      title: 'Adobe Experience Cloud22'
-    });
-    const newConfig = {
-      icon: 'AdobeExample',
-      shortTitle: 'AEC',
-      title: 'Example Solution'
-    };
-    topbar.solution = newConfig;
-    expect(Global['exc-module-runtime'].topbar.solution).toStrictEqual(newConfig);
-
-    expect(topbar.customEnvLabel).toBe('Test');
-    topbar.customEnvLabel = 'Beta';
-    expect(Global['exc-module-runtime'].topbar.customEnvLabel).toBe('Beta');
-
-    expect(topbar.workspaces).toStrictEqual([{name: 'Workspace', url: '/workspace'}]);
-    topbar.workspaces = [{name: 'New Workspace', url: '/newWorkspace'}];
-    expect(Global['exc-module-runtime'].topbar.workspaces).toStrictEqual([{name: 'New Workspace', url: '/newWorkspace'}]);
-
-    expect(typeof topbar.onHeroClick).toBe('function');
-    const newCallback = () => {};
-    const heroClickSpy = jest.spyOn(Global['exc-module-runtime'].topbar, 'onHeroClick');
-    topbar.onHeroClick(newCallback);
-    expect(heroClickSpy).toBeCalledWith(newCallback);
-
-    const feedbackCallback = jest.fn();
-    const feedbackButtonSpy = jest.spyOn(Global['exc-module-runtime'].topbar, 'setFeedbackButton');
-    topbar.setFeedbackButton({buttonLabel: 'Beta Feedback', callback: feedbackCallback, enabled: true, type: 'custom'});
-    topbar.setFeedbackButton({buttonLabel: 'Beta Feedback', enabled: true, subject: 'Subject', type: 'openFeedback'});
-    topbar.setFeedbackButton({buttonLabel: 'Beta Feedback', enabled: true, type: 'external', url: 'http://example.com'});
-    expect(feedbackButtonSpy).toBeCalledTimes(3);
-  });
-});

package/tests/user.test.ts

@@ -1,129 +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.
- **************************************************************************/
-import Global, {Modules} from '../src/Global';
-import user, {IMS, UserApi, UserInfo} from '../user';
-
-describe('user.ts', () => {
-  const evt = '';
-  const handler = () => {};
-  const userMock = {
-    authExpired: () => {},
-    emit: (type, evt) => {
-      return {evt, type};
-    },
-    get: (param: UserInfo) => {
-      return Promise.resolve(param);
-    },
-    getCustomToken: (ims: IMS) => {
-      return Promise.resolve(ims.toString());
-    },
-    logoutUrl: 'https://localhost/logout',
-    off: (type, handler) => {
-      return {handler, type};
-    },
-    on: (type, handler) => {
-      return {handler, type};
-    },
-    showLanguagePicker: undefined
-  } as UserApi;
-
-  beforeEach(() => {
-    (Global['exc-module-runtime'] as Modules) = {
-      user: () => {
-        return userMock;
-      }
-    } as Modules;
-  });
-
-  it('can emit()', () => {
-    const spy = jest.spyOn(userMock, 'emit');
-
-    // action
-    user.emit('change:theme', evt),
-
-    // verify
-    expect(spy).toBeCalledTimes(1);
-    expect(spy).toBeCalledWith('change:theme', evt);
-  });
-
-  it('can get()', async () => {
-    const spy = jest.spyOn(userMock, 'get');
-
-    // action
-    await Promise.all([
-      user.get('imsOrg'),
-      user.get('imsOrgName'),
-      user.get('imsOrgs'),
-      user.get('imsToken'),
-      user.get('imsProfile'),
-      user.get('locale'),
-      user.get('preferredLanguages'),
-      user.get('sandbox'),
-      user.get('sandboxes'),
-      user.get('subOrg'),
-      user.get('tenant'),
-      user.get('theme')
-    ]);
-
-    // verify
-    expect(spy).toBeCalledTimes(12);
-    expect(spy).toBeCalledWith('imsOrg');
-    expect(spy).toBeCalledWith('imsOrgName');
-    expect(spy).toBeCalledWith('imsOrgs');
-    expect(spy).toBeCalledWith('imsToken');
-    expect(spy).toBeCalledWith('imsProfile');
-    expect(spy).toBeCalledWith('locale');
-    expect(spy).toBeCalledWith('preferredLanguages');
-    expect(spy).toBeCalledWith('sandbox');
-    expect(spy).toBeCalledWith('sandboxes');
-    expect(spy).toBeCalledWith('subOrg');
-    expect(spy).toBeCalledWith('tenant');
-    expect(spy).toBeCalledWith('theme');
-
-    // Verify logoutUrl getter
-    expect(user.logoutUrl).toEqual('https://localhost/logout');
-  });
-
-  it('can getCustomToken()', async () => {
-    const spy = jest.spyOn(userMock, 'getCustomToken');
-    user.getCustomToken({client_id: 'client', scopes: 'scope1,scope2'});
-    expect(spy).toBeCalledTimes(1);
-  });
-
-  it('can off()', () => {
-    const spy = jest.spyOn(userMock, 'off');
-
-    // action
-    user.off('change:imsOrg', handler),
-
-    // verify
-    expect(spy).toBeCalledTimes(1);
-    expect(spy).toBeCalledWith('change:imsOrg', handler);
-  });
-
-  it('can on()', () => {
-    const spy = jest.spyOn(userMock, 'on');
-
-    // action
-    user.on('change:tenant', handler);
-
-    // verify
-    expect(spy).toBeCalledTimes(1);
-    expect(spy).toBeCalledWith('change:tenant', handler);
-  });
-
-  it('can call authExpired', () => {
-    const user = Global['exc-module-runtime'].user();
-    const authExpiredSpy = jest.spyOn(user, 'authExpired');
-    user.authExpired();
-    expect(authExpiredSpy).toBeCalledTimes(1);
-  });
-});

package/tests/userprofile.test.ts

@@ -1,31 +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.
- **************************************************************************/
-import Global, {Modules} from '../src/Global';
-import userProfile from '../userprofile';
-
-describe('userProfile', () => {
-  beforeEach(() => {
-    (Global['exc-module-runtime'] as Modules) = {
-      userProfile: {
-        setButtons: (buttons) => {
-          console.log(buttons); // eslint-disable-line no-console
-        }
-      }
-    } as Modules;
-  });
-
-  it('correctly sets up the connection with module-runtime', () => {
-    const setButtons = jest.spyOn(Global['exc-module-runtime'].userProfile, 'setButtons');
-    const callbackFn = jest.fn();
-    userProfile.setButtons([{callback: callbackFn, id: 'idx', label: 'myButton'}]);
-    expect(setButtons).toBeCalledTimes(1);
-  });
-});

package/topbar.ts

@@ -1,288 +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 the top bar and personalize it, e.g. configuring the
- * solution area on the left, setting up workspaces, custom search, etc.
- *
- * ***Import:***
- *
- * ```typescript
- * import topbar from '@adobe/exc-app/topbar';
- * ```
- *
- * ***Default export:***
- *
- * [TopbarApi](../interfaces/topbar.topbarapi.md#interface-topbarapi)
- *
- * ***Usage:***
- *
- * ```typescript
- * import topbar from '@adobe/exc-app/topbar';
- *
- * topbar.customEnvLabel = 'Beta';
- * ```
- * @packageDocumentation
- * @module topbar
- */
-
-import {connect} from './src/Global';
-
-/**
- * Defines the attributes of the solution to display on the left-side of the top bar.
- */
-export interface Solution {
-  /**
-   * The icon to display in the solution area. If this isn't set, then the default experience cloud
-   * icon will be used.
-   */
-  icon: string;
-
-  /**
-   * The title to display on smaller browser resolutions where the horizonal space is constrained.
-   */
-  shortTitle: string;
-
-  /**
-   * The title to display. Defaults to 'Adobe Experience Cloud'.
-   */
-  title: string;
-}
-
-export interface CustomSearchConfig {
-  /**
-   * Used to control whether or not the search icon in the top bar is enabled and clickable.
-   */
-  enabled?: boolean;
-
-  /**
-   * Flag used to notify shell whether the custom search dialog has been opened/closed.
-   */
-  open?: boolean;
-
-  /**
-   * The callback to execute when the search icon is clicked.
-   */
-  callback?: Callback;
-}
-
-/**
- * @ignore
- */
-export interface CoachMarkConfig {
-  /**
-   * The callback to execute when the position of the element Coach Marks is pointing to is updated.
-   * The position, which specifies the horizontal position of the element in pixels,
-   * will be passed as an argument to the callback.
-   */
-  callback?: CoachMarkCallback;
-
-  /**
-   * Valid CSS selector string indicating which element Coach Marks should be pointing to.
-   */
-  element: string;
-
-  /**
-   * Whether or not Coach Marks is currently enabled in the Shell.
-   */
-  enabled: boolean;
-}
-
-export interface CustomFeedbackConfig {
-  buttonLabel: string;
-  callback: Callback;
-  enabled: boolean;
-  type: 'custom';
-}
-
-export interface ExternalFeedbackConfig {
-  buttonLabel: string;
-  enabled: boolean;
-  type: 'external';
-  url: string;
-}
-
-export interface HelpCenterFeedbackConfig {
-  buttonLabel: string;
-  enabled: boolean;
-  subject?: string;
-  type: 'openFeedback';
-}
-
-interface WorkspaceMenu {
-  /**
-   * Workspace name shown on the tab (unique).
-   */
-  name: string;
-
-  /**
-   * Optional when menu is used. Path when workspace is clicked. This can alternatively be a full
-   * url. This must be a path if it needs to stay within the Unified Shell.
-   */
-  url?: string;
-
-  /**
-   * Optionally nest related links within an n-level menu underneath the workspace.
-   */
-  menu?: Array<WorkspaceMenu>;
-
-  /**
-   * If the workspace should open in a new tab.
-   */
-  newtab?: boolean;
-
-  /**
-   * Optional array of regexes that allow the solution application to decide when a workspace should
-   * be selected. This is useful when there is a workspace like items and diving into a single item
-   * nets a URL like item/<id>. The same workspace should probably still be selected in this case,
-   * so the value of this option might be [/item\/\d*\/]
-   */
-  selectOn?: RegExp[];
-}
-
-export interface Callback {(value?: any): void}
-
-/**
- * @ignore
- */
-export interface CoachMarkCallback {(value?: number): void}
-
-export interface TopbarApiProperties {
-  /**
-   * Gets or sets a custom environment label in the shell.
-   *
-   * ***Example:***
-   *
-   * ```typescript
-   * topbar.customEnvLabel = 'Beta';
-   * ```
-   */
-  customEnvLabel: string;
-
-  /**
-   * Configuration for solution name and hero. All values aside from
-   * path can only be used by third party applications. All other solutions will use
-   * their default product set branding as of the 2020 branding changes.
-   *
-   * ***Example:***
-   *
-   * ```typescript
-   * topbar.solution = {
-   *   icon: 'AdobeExperienceCloud',
-   *   path: '/alternatepath/for/heroclick',
-   *   shortTitle: 'AEC',
-   *   title: 'Adobe Experience Cloud22'
-   * };
-   * ```
-   */
-  solution: Solution;
-
-  /**
-   * Configuration for the Shell workspaces. Workspace names should be unique, and should be
-   * localized using the unified shell locale prior to setting runtime.workspaces.
-   *
-   * ```typescript
-   * topbar.workspaces = [
-   *   {name: 'Home', url: '/'},
-   *   {name: 'ABC', url: '/abc'},
-   *   {name: 'DEF', url: '/def'}
-   * ];
-   * ```
-   *
-   * Unified shell also supports workspace flyout menus, where clicking on a workspace displays a
-   * dropdown menu. The top-level workspace is present in the dropdown menu as the first menu item.
-   * Menus may be nested multiple times, and used in combination with normal workspaces. By default,
-   * parent menu items will be automatically added to the sub-menu due to how the user interaction
-   * works. To prevent this functionality, simply remove the url property on the parent item and it
-   * will not be injected into the sub-menu.
-   *
-   * ```typescript
-   * topbar.workspaces = [
-   *   {name: 'Home', url: '/'},
-   *   {name: 'ABC', url: '/abc'},
-   *   {
-   *     name: 'DEF',
-   *     url: '/def',
-   *     menu: [
-   *       {
-   *         name: 'GHI',
-   *         url: '/def/ghi',
-   *         menu: [
-   *           {name: 'JKL', url: '/def/ghi/jkl'}
-   *         ]
-   *       }
-   *     ]
-   *   }
-   * ];
-   * ```
-   */
-  workspaces: WorkspaceMenu[];
-}
-
-/**
- * Defines page-level APIs available to solutions.
- */
-export interface TopbarApi extends TopbarApiProperties {
-  /**
-   * Registers a callback to execute when the hero (solution) icon in the upper lefthand corner of
-   * the Shell is clicked.
-   * @param callback The callback to execute.
-   */
-  onHeroClick(callback: Callback): void;
-
-  /**
-   * Determines whether or not to enable the custom search property and enacts a callback
-   * when the custom search icon is clicked.
-   */
-  setCustomSearch(config: CustomSearchConfig | null): void;
-
-  /**
-   * Determines whether or not Coach Mark is enabled within the Shell and which element
-   * should currently be pointed to based on the CSS selector string. If no position is available,
-   * the selector is either not valid or the element was hidden due to the screen width being too small.
-   *
-   * ```typescript
-   * topbar.setCoachMark({
-   *   callback: (position) => {
-   *     if (!position) {
-   *       return this.setState({coachMark {enabled: false, position}});
-   *     }
-   *     this.setState({coachMark: {enabled: true, position}});
-   *   },
-   *   element: '#hero',
-   *   enabled: true
-   * })
-   * ```
-   * @param config The Coach Mark configuration with valid CSS selector and enabled boolean.
-   * Enacts a callback when the Coach Mark is enabled and positioned on an element.
-   */
-  /**
-   * @ignore
-   */
-  setCoachMark(config: CoachMarkConfig | null): void;
-
-  /**
-   * Determines whether or not to enable a feedback button.
-   */
-  setFeedbackButton(config: CustomFeedbackConfig | HelpCenterFeedbackConfig | ExternalFeedbackConfig | null): void;
-}
-
-const topbar = connect('topbar', [
-  ['customEnvLabel'],
-  ['onHeroClick', true],
-  ['setCustomSearch', true],
-  ['setCoachMark', true],
-  ['setFeedbackButton', true],
-  ['solution'],
-  ['workspaces']
-]);
-
-export default topbar;