@adobe/exc-app 0.2.46 → 1.0.1

package/sidebar.ts

@@ -1,208 +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 Sidebar nav.
- *
- * ***Import:***
- *
- * ```typescript
- * import sidebar from '@adobe/exc-app/sidebar';
- * ```
- *
- * ***Default export:***
- *
- * [SidebarApi](../interfaces/sidebar.sidebarapi.md#interface-sidebarapi)
- *
- * ***Usage:***
- *
- * ```typescript
- * sidebar.config = {
- *   menu: [
- *     {absolutePath: true, id: 'home', name: 'Home', url: '/home'},
- *     {id: 'example', name: 'Example', url: '/'},
- *     {id: 'journeys', name: 'Journeys', url: '/journeys'},
- *     {
- *       heading: 'STORAGE',
- *       items: [
- *         {id: 'external', name: 'External', target: '_blank', url: 'https://adobe.com'}
- *       ]
- *     },
- *     {
- *       heading: 'DOCUMENTS',
- *       items: [
- *         {children: [{id: 'child1', name: 'Child 1'}, {id: 'child2', name: 'Child 2'}], id: '2', name: 'Item 2'}
- *       ]
- *     }
- *   ],
- *   settings: {
- *     typeToSelect: true,
- *     variant: 'multiLevel'
- *   }
- * };
- *
- * sidebar.visible = false;
- * ```
- * @packageDocumentation
- * @module sidebar
- */
-
-import {connect} from './src/Global';
-
-export interface NavItem {
-  /**
-   * Whether the path is absolute or relative to the base path.
-   */
-  absolutePath?: boolean;
-  /**
-   * Nested children Sidebar nav items
-   */
-  children?: NavItem[];
-  /**
-   * Whether or not to expand children by default.
-   */
-  defaultExpanded?: boolean;
-  /**
-   * Whether or not to disable the nav item.
-   */
-  disabled?: boolean;
-  /**
-   * ID of the Sidebar nav item.
-   */
-  id: string;
-  /**
-   * The label and display name of the Sidebar nav item.
-   */
-  name: string;
-  /**
-   * Where to open external URL e.g., '_self' or '_blank' for same tab or new tab.
-   */
-  target: string;
-  /**
-   * A string url the user is taken to when this item is clicked.
-   */
-  url?: string;
-}
-
-export interface NavSettings {
-  /**
-   * ID of the Sidebar nav.
-   * */
-  id: string;
-  /**
-   * Whether or not to enable type to select.
-   */
-  typeToSelect?: boolean;
-  /**
-   * Type and style of Sidebar nav.
-   */
-  variant?: 'default' | 'multiLevel';
-}
-
-export interface NavConfig {
-  /**
-   * List of nav item objects.
-   */
-  menu: NavItem[];
-  /**
-   * Extra Sidebar nav options and configurations.
-   */
-  settings?: NavSettings;
-}
-
-/**
- * @deprecated APIs that let solutions interact with Sidebar nav.
- * This is now deprecated in favor of the sidenav api.
- * Remove this once all solutions have been transitioned to sidenav.
- */
-export interface SidebarApi {
-  /**
-   * Configuration to add headings, items, and other settings to the Sidebar nav.
-   *
-   * ***Example:***
-   *
-   * ```typescript
-   * sidebar.config = {
-   *   menu: [
-   *     {absolutePath: true, id: 'home', name: 'Home', url: '/home'},
-   *     {id: 'example', name: 'Example', url: '/'},
-   *     {id: 'journeys', name: 'Journeys', url: '/journeys'},
-   *     {
-   *       heading: 'STORAGE',
-   *       items: [
-   *         {id: 'external', name: 'External', target: '_blank', url: 'https://adobe.com'}
-   *       ]
-   *     },
-   *     {
-   *       heading: 'DOCUMENTS',
-   *       items: [
-   *         {children: [{id: 'child1', name: 'Child 1'}, {id: 'child2', name: 'Child 2'}], id: '2', name: 'Item 2'}
-   *       ]
-   *     }
-   *   ],
-   *   settings: {
-   *     typeToSelect: true,
-   *     variant: 'multiLevel'
-   *   }
-   * };
-   * ```
-   *
-   * Options:
-   * * menu: List of nav items and headers and their nested (children) nav items to add to the Sidebar nav. There are two types:
-   *   * Heading Nav Item
-   *      * heading: The heading name. This string needs to be translated using the locale shell provides.
-   *      * items: The list of nav items that belong under the heading. Each nav items should have the below properties
-   *   * Regular Nav Item
-   *     * id: Unique id and value of the nav item.
-   *     * name: The nav item's label and display name. This string needs to be translated using the locale shell provides.
-   *     * children: (optional) List of children nav item objects nested under the current nav item.
-   *     * defaultExpanded: (optional) Whether or not this item's children are expanded and shown by default.
-   *     * disabled: (optional) Whether or not this item is disabled.
-   *     * target: (optional) Where to open external URL e.g., '_self' or '_blank' for same tab or new tab.
-   *     * url: A string url the user is taken to when this item is clicked.
-   *     * absolutePath: Whether the path is absolute or relative to the base path.
-   * * settings: Optional object of additional settings for the Sidebar nav.
-   *   * id: Unique id and value of the sidebar nav.
-   *   * typeToSelect: Whether to enable typing to select an item.
-   *   * variant: Can be one of two values: default or multiLevel. If there is nested children, use multiLevel.
-   */
-  config: NavConfig;
-
-  /**
-   * Whether the Sidebar nav should start out as collapsed or not.
-   *
-   * ***Example:***
-   *
-   * ```typescript
-   * sidebar.collapsed = true;
-   * ```
-   */
-  collapsed: boolean;
-
-  /**
-   * Whether the Sidebar nav should currently be visible or not.
-   *
-   * ***Example:***
-   *
-   * ```typescript
-   * sidebar.visible = false;
-   * ```
-   */
-  visible: boolean;
-}
-
-const sidebar = connect('sidebar', [
-  ['config'],
-  ['collapsed'],
-  ['visible']
-]);
-
-export default sidebar;

package/sidenav.ts

@@ -1,287 +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 Sidenav nav.
- *
- * ***Import:***
- *
- * ```typescript
- * import sidenav from '@adobe/exc-app/sidenav';
- * ```
- *
- * ***Default export:***
- *
- * [SidenavApi](../interfaces/sidenav.sidenavapi.md#interface-sidenavapi)
- *
- * ***Usage:***
- *
- * ```typescript
- * sidenav.config = {
- *   menu: [
- *     {absolutePath: true, id: 'home', name: 'Home', url: '/home'},
- *     {id: 'example', name: 'Example', url: '/'},
- *     {id: 'journeys', name: 'Journeys', url: '/journeys'},
- *     {
- *       heading: 'STORAGE',
- *       items: [
- *         {id: 'external', name: 'External', target: '_blank', url: 'https://adobe.com'}
- *       ]
- *     },
- *     {
- *       heading: 'DOCUMENTS',
- *       items: [
- *         {children: [{id: 'child1', name: 'Child 1'}, {id: 'child2', name: 'Child 2'}], id: '2', name: 'Item 2'}
- *       ]
- *     }
- *   ],
- *   settings: {
- *     typeToSelect: true,
- *     variant: 'multiLevel'
- *   }
- * };
- *
- * sidenav.visible = false;
- * sidenav.collapsed = true;
- *
- * console.log(sidenav.visible);
- * console.log(sidenav.collapsed);
- * ```
- *
- * ### Receiving updates
- *
- * You can also listen for updates on the requested data by listening to specific change events.
- *
- * These change events are emitted from the api that the data is requested from. For example, if a
- * user calls `await sidenav.get('shellSideNavCollapsed');` they must listen for the change event on
- * `user.on('change:shellSideNavCollapsed')`. Here is a more detailed example of how the promise
- * api and change events can be used to keep track of specific values from the config:
- *
- * ```typescript
- * import sidenav from '@adobe/exc-app/sidenav';
- *
- * constructor() {
- *   this.state = {shellSideNavCollapsed: false};
- *
- *   sidenav.on('change:shellSideNavCollapsed', (shellSideNavCollapsed) => {
- *     this.setState({shellSideNavCollapsed});
- *   });
- * }
- *
- * async componentDidMount() {
- *   const shellSideNavCollapsed = await user.get('shellSideNavCollapsed');
- *   this.setState({shellSideNavCollapsed});
- * }
- * ```
- * @packageDocumentation
- * @module sidenav
- */
-
-import EventEmitter from './src/EventEmitter';
-import {getImpl} from './src/Global';
-
-export interface NavItem {
-  /**
-   * Whether the path is absolute or relative to the base path.
-   */
-  absolutePath?: boolean;
-  /**
-   * Nested children Sidenav nav items
-   */
-  children?: NavItem[];
-  /**
-   * Whether or not to expand children by default.
-   */
-  defaultExpanded?: boolean;
-  /**
-   * Whether or not to disable the nav item.
-   */
-  disabled?: boolean;
-  /**
-   * ID of the Sidenav nav item.
-   */
-  id: string;
-  /**
-   * The label and display name of the Sidenav nav item.
-   */
-  name: string;
-  /**
-   * Where to open external URL e.g., '_self' or '_blank' for same tab or new tab.
-   */
-  target: string;
-  /**
-   * A string url the user is taken to when this item is clicked.
-   */
-  url?: string;
-}
-
-export interface NavSettings {
-  /**
-   * ID of the Sidenav nav.
-   * */
-  id: string;
-  /**
-   * Whether or not to enable type to select.
-   */
-  typeToSelect?: boolean;
-  /**
-   * Type and style of Sidenav nav.
-   */
-  variant?: 'default' | 'multiLevel';
-}
-
-export interface NavConfig {
-  /**
-   * List of nav item objects.
-   */
-  menu: NavItem[];
-  /**
-   * Extra Sidenav nav options and configurations.
-   */
-  settings?: NavSettings;
-}
-
-export interface SidenavInfo {
-  shellSideNavCollapsed: boolean;
-}
-
-interface SidenavInfoEvent {
-  'change:shellSideNavCollapsed': boolean;
-}
-
-/**
- * APIs that let solutions interact with Sidenav nav.
- */
-export interface SidenavApi extends EventEmitter<SidenavInfoEvent> {
-  /**
-   * Configuration to add headings, items, and other settings to the Sidenav nav.
-   *
-   * ***Example:***
-   *
-   * ```typescript
-   * sidenav.config = {
-   *   menu: [
-   *     {absolutePath: true, id: 'home', name: 'Home', url: '/home'},
-   *     {id: 'example', name: 'Example', url: '/'},
-   *     {id: 'journeys', name: 'Journeys', url: '/journeys'},
-   *     {
-   *       heading: 'STORAGE',
-   *       items: [
-   *         {id: 'external', name: 'External', target: '_blank', url: 'https://adobe.com'}
-   *       ]
-   *     },
-   *     {
-   *       heading: 'DOCUMENTS',
-   *       items: [
-   *         {children: [{id: 'child1', name: 'Child 1'}, {id: 'child2', name: 'Child 2'}], id: '2', name: 'Item 2'}
-   *       ]
-   *     }
-   *   ],
-   *   settings: {
-   *     typeToSelect: true,
-   *     variant: 'multiLevel'
-   *   }
-   * };
-   * ```
-   *
-   * Options:
-   * * menu: List of nav items and headers and their nested (children) nav items to add to the Sidenav nav. There are two types:
-   *   * Heading Nav Item
-   *      * heading: The heading name. This string needs to be translated using the locale shell provides.
-   *      * items: The list of nav items that belong under the heading. Each nav items should have the below properties
-   *   * Regular Nav Item
-   *     * id: Unique id and value of the nav item.
-   *     * name: The nav item's label and display name. This string needs to be translated using the locale shell provides.
-   *     * children: (optional) List of children nav item objects nested under the current nav item.
-   *     * defaultExpanded: (optional) Whether or not this item's children are expanded and shown by default.
-   *     * disabled: (optional) Whether or not this item is disabled.
-   *     * target: (optional) Where to open external URL e.g., '_self' or '_blank' for same tab or new tab.
-   *     * url: A string url the user is taken to when this item is clicked.
-   *     * absolutePath: Whether the path is absolute or relative to the base path.
-   * * settings: Optional object of additional settings for the Sidenav nav.
-   *   * id: Unique id and value of the sidenav nav.
-   *   * typeToSelect: Whether to enable typing to select an item.
-   *   * variant: Can be one of two values: default or multiLevel. If there is nested children, use multiLevel.
-   */
-  config?: NavConfig;
-
-  /**
-   * Whether the Sidenav nav should start out as collapsed or not.
-   *
-   * ***Example:***
-   *
-   * ```typescript
-   * sidenav.collapsed = true;
-   * ```
-   */
-  collapsed?: boolean;
-
-  /**
-   * Gets the specified type of information about the sidenav.
-   * @param type The type of information to get.
-   */
-  get<T extends keyof SidenavInfo>(type: T): Promise<SidenavInfo[T]>;
-
-  /**
-   * Whether the Sidenav nav should currently be visible or not.
-   *
-   * ***Example:***
-   *
-   * ```typescript
-   * sidenav.visible = false;
-   * ```
-   */
-  visible?: boolean;
-}
-
-const sidenav = {
-  emit: (type, evt) => {
-    return getImpl('sidenav')().emit(type, evt);
-  },
-  get: params => {
-    return getImpl('sidenav')().get(params);
-  },
-  off: (type, handler) => {
-    return getImpl('sidenav')().off(type, handler);
-  },
-  on: (type, handler) => {
-    return getImpl('sidenav')().on(type, handler);
-  }
-} as SidenavApi;
-
-Object.defineProperty(sidenav, 'config', {
-  get: (): NavConfig | undefined => {
-    return getImpl('sidenav')().config;
-  },
-  set: (value: NavConfig | undefined) => {
-    getImpl('sidenav')().config = value;
-  }
-});
-
-Object.defineProperty(sidenav, 'collapsed', {
-  get: (): boolean | undefined => {
-    return getImpl('sidenav')().collapsed;
-  },
-  set: (value: boolean) => {
-    getImpl('sidenav')().collapsed = value;
-  }
-});
-
-Object.defineProperty(sidenav, 'visible', {
-  get: (): boolean | undefined => {
-    return getImpl('sidenav')().visible;
-  },
-  set: (value: boolean) => {
-    getImpl('sidenav')().visible = value;
-  }
-});
-
-export default sidenav;

package/src/EventEmitter.ts

@@ -1,44 +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 "index"
- */
-
-/**
- * @ignore
- */
-export default interface EventEmitter<T = Record<string, any>> {
-  /**
-   * Register an event handler for the given type.
-   * @param type Type of event to listen for.
-   * @param handler Function to call in response to given event.
-   * @category EventEmitter
-   */
-  on<K extends keyof T>(type: K, handler: (event?: T[K]) => void): void;
-
-  /**
-   * Remove an event handler for the given type.
-   * @param type Type of event to unregister `handler` from.
-   * @param handler Handler function to remove.
-   * @category EventEmitter
-   */
-  off<K extends keyof T>(type: K, handler: (event?: T[K]) => void): void;
-
-  /**
-   * Invoke all handlers for the given type.
-   * @param type The event type to invoke.
-   * @param event Any value (object is recommended and powerful), passed to each handler.
-   * @category EventEmitter
-   */
-  emit<K extends keyof T>(type: K, event?: T[K]): void;
-}

package/src/Global.ts

@@ -1,109 +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 "index"
- */
-import {AppApi} from '../appapi';
-import {CapabilityApi} from '../capabilityapi';
-import {HelpCenterApi} from '../helpcenter';
-import {InternalApi} from '../internal';
-import {MetricsApi} from '../metrics';
-import {NetworkApi} from '../network';
-import {Nps} from '../nps';
-import {OrgSwitcherApi} from '../orgswitcher';
-import {PageApi} from '../page';
-import {PermissionsApi} from '../permissions';
-import {PulseApi} from '../pulse';
-import Runtime from './Runtime';
-import {SessionApi} from '../session';
-import {SettingsApi} from '../settings';
-import {ShellApi} from '../shell';
-import {SidebarApi} from '../sidebar';
-import {SidenavApi} from '../sidenav';
-import {TopbarApi} from '../topbar';
-import {UserApi} from '../user';
-import {UserProfileApi} from '../userprofile';
-
-export interface Modules {
-  readonly appApi: () => AppApi;
-  readonly capabilityApi: () => CapabilityApi;
-  readonly default: (options?: any) => Runtime;
-  readonly helpCenter: HelpCenterApi;
-  readonly internal: InternalApi;
-  readonly metrics: MetricsApi;
-  readonly network: NetworkApi;
-  readonly nps: Nps;
-  readonly orgSwitcher: OrgSwitcherApi;
-  readonly page: PageApi;
-  readonly permissions: () => PermissionsApi;
-  readonly pulse: () => PulseApi;
-  runtime: Runtime;
-  readonly settings: () => SettingsApi;
-  readonly topbar: TopbarApi;
-  readonly session: () => SessionApi;
-  readonly shell: () => ShellApi;
-  readonly sidebar: SidebarApi;
-  readonly sidenav: () => SidenavApi;
-  readonly user: () => UserApi;
-  readonly userProfile: UserProfileApi;
-}
-
-type Global = typeof window & {
-  readonly 'exc-module-runtime': Modules;
-  EXC_MR_READY: () => void;
-};
-
-/**
- * Gets the implementation for the module.
- * @ignore
- * @param moduleName The name of the module.
- * @returns The implementation.
- */
-export function getImpl<T extends keyof Modules>(moduleName: T): Modules[T] {
-  const emr = (window as Global)['exc-module-runtime'];
-  if (!emr) {
-    throw new Error('module-runtime APIs not available.');
-  }
-  return emr[moduleName];
-}
-
-/**
- * Connects attributes of the specified API.
- * @ignore
- * @param apiName Name of the API.
- * @param attributes The attributes to connect.
- * @returns The API instance.
- */
-export function connect<T extends keyof Modules>(apiName: T, attributes: [keyof Modules[T], boolean?][]): Modules[T] {
-  const api = {} as Modules[T];
-  attributes.forEach(feature => {
-    const featureName = feature[0];
-    if (feature[1]) {
-      api[featureName] = ((...args: any[]) => {
-        return (getImpl(apiName)[featureName] as any)(...args);
-      }) as any;
-    } else {
-      Object.defineProperty(api, featureName, {
-        get: () => {
-          return getImpl(apiName)[featureName];
-        },
-        set: value => {
-          getImpl(apiName)[featureName] = value;
-        }
-      });
-    }
-  });
-  return api;
-}
-
-export default (window as Global);

package/src/Runtime.ts

@@ -1,23 +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 "index"
- */
-
-import EventEmitter from './EventEmitter';
-
-/**
- * Defines the runtime object providing all unified-shell APIs for solution authors.
- */
-export default interface Runtime extends EventEmitter { // eslint-disable-line @typescript-eslint/no-empty-interface
-}

package/tests/MockRuntime.ts

@@ -1,28 +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 {Runtime} from '..';
-
-export default class MockRuntime implements Runtime {
-  on(type: string, handler: (event?: any) => void): void {
-    console.log(type, handler); // eslint-disable-line no-console
-    throw new Error('Method not implemented.');
-  }
-
-  off(type: string, handler: (event?: any) => void): void {
-    console.log(type, handler); // eslint-disable-line no-console
-    throw new Error('Method not implemented.');
-  }
-
-  emit(type: string, evt?: any): void {
-    console.log(type, evt); // eslint-disable-line no-console
-    throw new Error('Method not implemented.');
-  }
-}