@adobe/exc-app 0.2.45 → 1.0.0

package/user.ts

@@ -1,228 +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 to request user-specific information such as IMS organization, IMS profile, access token,
- * tenant, etc. It also  provides solutions with other capabilities such as notifying the shell that
- * the session has expired and configuring a logout URL to expire custom sessions.
- *
- * ***Import:***
- *
- * ```typescript
- * import user from '@adobe/exc-app/user';
- * ```
- *
- * ***Default export:***
- *
- * [UserApi](../interfaces/user.userapi.md#interface-userapi)
- *
- * ***Usage:***
- *
- * Below is an example of how to get various attributes associated to the user:
- *
- * ```typescript
- * import user from '@adobe/exc-app/user';
- *
- * const [orgInfo, org, name, orgs, token, profile, locale, languages, subOrg, tenant, theme] = await Promise.all([
- *   user.get('imsInfo'),
- *   user.get('imsOrg'),
- *   user.get('imsOrgName'),
- *   user.get('imsOrgs'),
- *   user.get('imsToken'),
- *   user.get('imsProfile'),
- *   user.get('locale'),
- *   user.get('preferredLanguages'),
- *   user.get('subOrg'),
- *   user.get('tenant'),
- *   user.get('theme')
- * ]);
- * ```
- *
- * ### 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 user.get('locale');` they must listen for the change event on
- * `user.on('change:locale')`. If a user calls `await user.get('imsOrg')` they must listen for the
- * change event on `user.on('change:imsOrg')`. 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 user from '@adobe/exc-app/user';
- *
- * constructor() {
- *   this.state = {org: null, shell: {}};
- *
- *   user.on('change:imsOrg', (org) => {
- *     this.setState({org});
- *   });
- * }
- *
- * async componentDidMount() {
- *   const org = await user.get('imsOrg');
- *   this.setState({org});
- * }
- * ```
- *
- * imsInfo is a special case. When listening for updates on imsInfo, the callback will receive
- * two arguments. The first is the entire imsInfo object. The second is an object containing only
- * the values that have changed (for example, an org change between an individual account and a
- * type2e account will cause the imsProfile to change, while an org change within the same account will not).
- *
- * ```typescript
- *  user.on('change:imsInfo', (info, changed) => {
- *     if ('imsProfile' in changed) {
- *       // load information for new account
- *     }
- *
- *     this.setState({...info});
- *   });
- * ```
- * @packageDocumentation
- * @module user
- */
-
-import EventEmitter from './src/EventEmitter';
-import {getImpl} from './src/Global';
-
-export interface Sandbox {
-  isDefault: boolean;
-  name: string;
-  region: string;
-  state: string;
-  title: string;
-  type: string;
-}
-
-export interface IMS {
-  client_id: string;
-  scopes: string;
-}
-
-/**
- * ImsInfo encompasses all of the information associated with a given ims org.
- */
-export interface IMSInfo {
-  imsOrg?: string;
-  imsOrgName?: string;
-  imsProfile?: Record<string, any>;
-  imsToken?: string;
-  locale?: string;
-  tenant?: string;
-}
-
-export interface UserInfo {
-  imsInfo: IMSInfo;
-  imsOrg: string;
-  imsOrgName: string;
-  imsOrgs: {label: string; value: string}[];
-  imsToken: string;
-  imsProfile: Record<string, any>;
-  locale: string;
-  preferredLanguages: string[];
-  sandbox: Sandbox;
-  sandboxes: Array<Sandbox>;
-  subOrg: string | null;
-  tenant: string;
-  theme: 'spectrum--darkest' | 'spectrum--lightest';
-}
-
-interface UserInfoEvent {
-  'change:imsInfo': IMSInfo;
-  'change:imsOrg': string;
-  'change:imsOrgName': string;
-  'change:imsOrgs': { label: string; value: string }[];
-  'change:imsToken': string;
-  'change:imsProfile': Record<string, any>;
-  'change:locale': string;
-  'change:preferredLanguages': string[];
-  'change:sandbox': Sandbox;
-  'change:sandboxes': Array<Sandbox>;
-  'change:subOrg': string | null;
-  'change:tenant': string;
-  'change:theme': string;
-}
-
-export interface UserApi extends EventEmitter<UserInfoEvent> {
-  /**
-   * API to notify the unified shell that APIs are returning 401 and user needs to be
-   * re-authenticated.
-   */
-  authExpired(): void;
-
-  /**
-   * API to do token exchange.
-   */
-  /**
-   * @ignore
-   */
-  getCustomToken(ims: IMS): Promise<string>;
-
-  /**
-   * Gets the specified type of information about an user.
-   * @param type The type of information to get.
-   */
-  get<T extends keyof UserInfo>(type: T): Promise<UserInfo[T]>;
-
-  /**
-   * 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
-   * (in addition to IMS).
-   */
-  logoutUrl: string | undefined;
-
-  /**
-   * If language picker should be opened.
-   */
-  showLanguagePicker: boolean | undefined;
-}
-
-const user = {
-  authExpired: () => {
-    return getImpl('user')().authExpired();
-  },
-  emit: (type, evt) => {
-    return getImpl('user')().emit(type, evt);
-  },
-  get: params => {
-    return getImpl('user')().get(params);
-  },
-  getCustomToken: (ims) => {
-    return getImpl('user')().getCustomToken(ims);
-  },
-  off: (type, handler) => {
-    return getImpl('user')().off(type, handler);
-  },
-  on: (type, handler) => {
-    return getImpl('user')().on(type, handler);
-  }
-} as UserApi;
-
-Object.defineProperty(user, 'logoutUrl', {
-  get: () => {
-    return getImpl('user')().logoutUrl;
-  },
-  set: (value) => {
-    getImpl('user')().logoutUrl = value;
-  }
-});
-
-Object.defineProperty(user, 'showLanguagePicker', {
-  get: (): boolean | undefined => {
-    return getImpl('user')().showLanguagePicker;
-  },
-  set: (value: boolean) => {
-    getImpl('user')().showLanguagePicker = value;
-  }
-});
-
-export default user;

package/userprofile.ts

@@ -1,93 +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 User Profile menu.
- *
- * ***Import:***
- *
- * ```typescript
- * import userProfile from '@adobe/exc-app/userProfile';
- * ```
- *
- * ***Default export:***
- *
- * [UserProfileApi](../interfaces/userprofile.userprofileapi.md#interface-userprofileapi)
- *
- * ***Usage:***
- *
- * ```typescript
- * import userProfile from '@adobe/exc-app/userProfile';
- *
- * userProfile.setButtons([{
- *   callback: () => {},
- *   id: 'button',
- *   label: 'Button'
- * }]);
- * ```
- *
- * This configuration is a method only for solutions that need to manage alternative User Profile flows not covered by the Shell.
- * @packageDocumentation
- * @module userProfile
- */
-import {connect} from './src/Global';
-
-export interface Button {
-  /**
-   * Callback function to be enacted onclick.
-   */
-  callback: (value?: any) => void;
-  /**
-   * Text shown on the button.
-   */
-  label: string;
-  /**
-   * Unique identifier for the button.
-   */
-  id: string;
-}
-
-/**
- * A maximum of 3 buttons can be supplied.
- */
-export type ButtonArray = [] | [Button] | [Button, Button] | [Button, Button, Button];
-
-/**
- * Defines the user profile api.
- */
-export interface UserProfileApi {
-  /**
-   * Adds custom button(s) to the profile dropdown and enacts a callback onclick.
-   * Custom user profile buttons may be reset by entering a null parameter.
-   * A maximum of 3 custom buttons will be displayed in the User Profile popover.
-   *
-   * ```typescript
-   * userProfile.setButtons([
-   *   {
-   *     callback: () => {},
-   *     label: 'Alpha',
-   *     id: 'alpha'
-   *   },
-   *   {
-   *     callback: () => {},
-   *     label: 'View My Profile',
-   *     id: 'viewprofile'
-   *   }
-   * ]);
-   * ```
-   */
-  setButtons(buttons: ButtonArray | null): void;
-}
-
-const userProfile = connect('userProfile', [
-  ['setButtons', true]
-]);
-
-export default userProfile;