@adobe/exc-app 0.2.46 → 1.0.1

package/pulse.ts

@@ -1,198 +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 Pulse, Adobe's Notification System.
- *
- * ***Import:***
- *
- * ```typescript
- * import pulse from '@adobe/exc-app/pulse';
- * ```
- *
- * ***Default export:***
- *
- * [PulseApi](../interfaces/pulse.pulseapi.md#interface-pulserapi)
- *
- * ***Usage:***
- *
- * ```typescript
- * import pulse, {NotificationType} from '@adobe/exc-app/pulse';
- *
- * pulse.send([{
- *   groupIds: [],
- *   messageType: NotificationType.UPDATES_ON_SUBSCRIBED_OBJECT,
- *   metadata: {priority: 'low'},
- *   sendToOrg: false,
- *   templateParams: {message: 'System shared Asset shared'},
- *   userIds: []
- * }]);
- * ```
- *
- * API for sending pulse notifications.
- * @packageDocumentation
- * @module pulse
- */
-
-import {getImpl} from './src/Global';
-
-/**
- * @ignore
- */
-export enum NotificationType {
-  /**
-   * Request for approval of a resource.
-   */
-  APPROVAL_REQUEST = 'approval_request',
-  /**
-   * Acceptance or rejection of an approval request.
-   */
-  APPROVAL_REQUEST_ACTION = 'approval_request_action',
-  /**
-   * Request for access.
-   */
-  ACCESS_REQUEST = 'access_request',
-  /**
-   * Acceptance or rejection of an access request.
-   */
-  ACCESS_REQUEST_ACTION = 'access_request_action',
-  /**
-   * Assignment notification.
-   */
-  ASSIGNED = 'assigned',
-  /**
-   * Sharing notification.
-   */
-  SHARED = 'shared',
-  /**
-   * Mentions notification.
-   */
-  MENTIONS = 'mentions',
-  /**
-   * Update notification.
-   */
-  UPDATES_ON_SUBSCRIBED_OBJECT = 'updates_on_subscribed_object',
-  /**
-   * Notification for completion with errors.
-   */
-  ERROR_COMPLETED_WITH_ERRORS = 'completed_with_errors',
-  /**
-   * Notification for failure with errors.
-   */
-  ERROR_FAILED_WITH_ERRORS = 'failed_with_errors',
-  /**
-   * Error default message.
-   */
-  ERROR_DEFAULT_MESSAGE = 'errors_default_message',
-  /**
-   * Other notification.
-   */
-  OTHERS = 'others'
-}
-
-export interface PulseNotification {
-  /**
-   * Type of Notification to be sent.
-   */
-  messageType: NotificationType;
-  /**
-   * A map of key value pairs which can be provided by publisher of notification for the consumer.
-   */
-  metadata?: Record<string, string>;
-  /**
-   * Templated parameters.
-   */
-  templateParams: Record<string, any>;
-  /**
-   * List of IMS user ids of the users to receive notification.
-   * A maximum of 100 user-ids are supported at a time.
-   */
-  userIds?: string[];
-  /**
-   * List of group ids to receive notification.
-   */
-  groupIds?: string[];
-  /**
-   * Specifies whether to send notifications to the complete IMS org.
-   */
-  sendToOrg?: boolean;
-}
-
-export interface PulseResponse {
-  /**
-   * Notifications
-   */
-  notifications: {
-    /**
-     * Specific notification.
-     */
-    notification: {
-      /**
-       * Status code for the notification.
-       */
-      statusCode: number;
-      /**
-       * Error message received if applicable.
-       */
-      errorMessage: string;
-      /**
-       * Id of the notification.
-       */
-      'notification-id': string;
-    }[];
-  };
-}
-
-export interface PulseButtonConfig {
-  /**
-   * Text of the button.
-   */
-  label: string;
-
-  /**
-   * Callback function to be automatically executed on click.
-   */
-  callback?: (value?: any) => void;
-}
-
-export interface PulseApi {
-  /**
-   * Method to send a pulse notification.
-   */
-  send(notifications: PulseNotification[]): Promise<PulseResponse>;
-
-  /**
-   * Adds an additional custom button to the bottom of the Pulse container.
-   * Will fire the attached callback when a user presses the button.
-   * @param buttonConfig The button configuration
-   */
-  setButton(buttonConfig: PulseButtonConfig): void;
-
-  /**
-   * Adds additional values to the notification.
-   * If Pulse has 3 internally and this is set to 2, the UI will show 5.
-   * @param count Additional values to add to the pulse notification.
-   */
-  setCount(count: number): void;
-}
-
-const pulse: PulseApi = {
-  send: params => {
-    return getImpl('pulse')().send(params);
-  },
-  setButton: (buttonConfig: PulseButtonConfig) => {
-    return getImpl('pulse')().setButton(buttonConfig);
-  },
-  setCount: (count: number) => {
-    return getImpl('pulse')().setCount(count);
-  }
-};
-
-export default pulse;

package/session.ts

@@ -1,116 +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.
- **************************************************************************/
-
-/**
- * APIs to get, set or invalidate session data. These APIs are meant for applications using their
- * own session management in addition Adobe IMS. These APIs are not meant to manage session but
- * rather cache and recycle them whenever possible.
- *
- * To consume this API, add the following import to your code.
- *
- * ```typescript
- * import session from '@adobe/exc-app/session';
- * ```
- *
- * The default export is an object of type [SessionApi](../interfaces/_session_.sessionapi.md)
- *
- * API reference: [scroll down](#index)
- *
- * ### Sample code
- *
- * ``` typescript
- * import session from '@adobe/exc-app/settings';
- *
- * // Get
- * const session = await session.get();
- *
- * // Set to expire an hour from now
- * await session.set({
- *   expires: Date.now() + 3600 * 1000,
- *   id: 'SESSION_ID'
- * });
- *
- * // Invalidate session
- * const session = await session.get();
- * await session.invalidate(session);
- * ```
- * @packageDocumentation
- * @module session
- */
-import {getImpl} from './src/Global';
-
-/**
- * Sets the scope validity. Ensuring a session can not be used outside of its context.
- */
-export enum SessionScope {
-  /**
-   * User - Session is valid for the current user only.
-   */
-  USER = 'user',
-  /**
-   * Organization - Session is valid for the current user and organization only.
-   */
-  ORG = 'org',
-  /**
-   * Context - Session is valid for the current user, organization and context only.
-   * Context depends on the solution - Could be Sandboxes or Sub orgs.
-   */
-  CONTEXT = 'context'
-}
-
-/**
- * The session object.
- */
-export interface Session {
-  /**
-   * Timestamp indicating session expiration time.
-   * 0 will use default TTL configured for the application.
-   */
-  expires: number;
-  /**
-   * Session identifier
-   */
-  id: string;
-}
-
-/**
- * APIs to get, set or invalidate session data. These APIs are meant for applications using their
- * own session management in addition Adobe IMS. These APIs are not meant to manage session but
- * rather cache and recycle them whenever possible.
- */
-export interface SessionApi {
-  /**
-   * Gets a stored session if one is available.
-   * @returns Session object
-   */
-  get(): Promise<Session>;
-
-  /**
-   * Stores the current session
-   * @param {object} Session object
-   */
-  set(session: Session): Promise<void>;
-
-  /**
-   * Invalidates a session if its current.
-   * @param {object} Session object
-   */
-  invalidate(session: Session): Promise<void>;
-}
-
-const session = {
-  get: () => getImpl('session')().get(),
-  invalidate: (session: Session) => getImpl('session')().invalidate(session),
-  set: (session: Session) => getImpl('session')().set(session)
-} as SessionApi;
-
-export default session;
-

package/settings.ts

@@ -1,147 +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 to get or set settings, preferences or configuration data that can be stored and retrieved
- * at an IMS user and/or an IMS org level. An app in unified shell can consume Settings service.
- *
- * To consume this API, add the following import to your code.
- *
- * ```typescript
- * import settings from '@adobe/exc-app/settings';
- * ```
- *
- * The default export is an object of type [SettingsApi](../interfaces/_settings_.settingsapi.md)
- *
- * API reference: [scroll down](#index)
- *
- * ### Sample code
- *
- * ```typescript
- * import settings, {SettingsLevel} from '@adobe/exc-app/settings';
- *
- * async function updateSettings(type: string, value: number) {
- *   const data = await settings.get({
- *     groupId: 'test-groupId',
- *     level: SettingsLevel.USER,
- *     settings: {key1: null}
- *   });
- *   data = data || {};
- *   data[type] = value;
- *   await settings.set({
- *     groupId: 'test-groupId',
- *     level: SettingsLevel.USER,
- *     settings: {key1: data}
- *   });
- * }
- * ```
- *
- * ### SettingsLevel
- *
- * Can be optionally specified to define the level at which settings are saved.
- *
- * * `SettingsLevel.USER` - use this level when you want to get/set settings per user.
- * * `SettingsLevel.USERORG` - should be used when settings are for user + org combination.
- * * `SettingsLevel.ORG` - use this level when you want to get/set settings per org.
- *
- * By default settings are saved at level `SettingsLevel.USERORG`. You can optionally override this
- * in the get/set API calls using the `level` parameter.
- *
- * ### Groups
- *
- * Apps can group their settings into different groups by different group IDs and keep multiple
- * settings in different groups. Apps are free to define their own groups for a particular selected
- * settings level.
- *
- * You can specify this in the get/set API calls using the `groupId` parameter.
- *
- * ### Sharing settings
- *
- * Set settingsAppId in the solution specific route configuration in order to share settings with
- * other applications.
- * @packageDocumentation
- * @module settings
- */
-
-import {getImpl} from './src/Global';
-import {SettingsLevel} from './settings/SettingsLevel';
-
-/**
- * A map of settings in the settings service.
- */
-export interface Settings {
-  [key: string]: any;
-}
-
-/**
- * The response from the settings service.
- */
-export interface SettingsResponse<T extends Settings> {
-  /**
-   * The map of settings being worked upon.
-   */
-  settings: T;
-}
-
-/**
- * The input parameters for the settings API.
- */
-export interface Parameters<T extends Settings> {
-  /**
-   * A unique identifier.
-   */
-  groupId: string;
-
-  /**
-   * A map of the settings key-value pairs. In case of `set` API, the value is saved and for the
-   * `get` API, the value is the fallback in case the key isn't present in the settings store.
-   */
-  settings: T;
-
-  /**
-   * The type of store to get/set the settings from/to. Defaults to `SettingsLevel.USERORG`.
-   */
-  level?: SettingsLevel;
-}
-
-/**
- * APIs to get or set settings, preferences or configuration data that can be stored and retrieved
- * at an IMS user and/or an IMS org level. An app in unified shell can consume Settings service.
- */
-export interface SettingsApi {
-  /**
-   * Gets settings based on the specified parameters such as groupId
-   * and settings - keys with default values to fallback.
-   * @param params Parameters used to identify settings to retrieve.
-   * @returns A promise for the specified settings.
-   */
-  get<T extends Settings>(params: Parameters<T>): Promise<SettingsResponse<T>>;
-
-  /**
-   * Creates or updates settings based on the specified parameters such as groupId and settings
-   * key-value pairs.
-   * @param params Parameters to identify the settings to create or update.
-   * @returns A promise for the operation response.
-   */
-  set<T extends Settings>(params: Parameters<T>): Promise<SettingsResponse<T>>;
-}
-
-const settings: SettingsApi = {
-  get: params => {
-    return getImpl('settings')().get(params);
-  },
-  set: params => {
-    return getImpl('settings')().set(params);
-  }
-};
-
-export {SettingsLevel};
-export default settings;

package/shell.ts

@@ -1,107 +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 shell-specific information such as environment and shellInfo.
- *
- * ***Import:***
- *
- * ```typescript
- * import shell from '@adobe/exc-app/shell';
- * ```
- *
- * ***Default export:***
- *
- * [ShellApi](../interfaces/shell.shellapi.md#interface-shellapi)
- *
- * ***Usage:***
- *
- * Below is an example of how to get various attributes associated to the shell:
- *
- * ```typescript
- * import shell from '@adobe/exc-app/shell';
- *
- * const [env, imsEnv, info] = await Promise.all([
- *   shell.get('environment'),
- *   shell.get('imsEnvironment'),
- *   shell.get('shellInfo')
- * ]);
- * ```
- *
- * ### 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
- * shell calls `await shell.get('shellInfo');` they must listen for the change event on
- * `shell.on('change:shellInfo')`. If a shell calls `await shell.get('environment')` they must listen for the
- * change event on `shell.on('change:environment')`. 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 shell from '@adobe/exc-app/shell';
- *
- * constructor() {
- *   this.state = {environment: null};
- *
- *   shell.on('change:environment', (env) => {
- *     this.setState({env});
- *   });
- * }
- *
- * async componentDidMount() {
- *   const env = await shell.get('environment');
- *   this.setState({env});
- * }
- * ```
- * @packageDocumentation
- * @module shell
- */
-
-import EventEmitter from './src/EventEmitter';
-import {getImpl} from './src/Global';
-
-export interface ShellInfo {
-  environment: string;
-  imsEnvironment: string;
-  shellInfo: Record<string, any>;
-}
-
-interface ShellInfoEvent {
-  'change:environment': string;
-  'change:imsEnvironment': string;
-  'change:shellInfo': Record<string, any>;
-}
-
-export interface ShellApi extends EventEmitter<ShellInfoEvent> {
-  /**
-   * Gets the specified type of information about the shell.
-   * @param type The type of information to get.
-   */
-  get<T extends keyof ShellInfo>(type: T): Promise<ShellInfo[T]>;
-}
-
-const shell = {
-  emit: (type, evt) => {
-    return getImpl('shell')().emit(type, evt);
-  },
-  get: params => {
-    return getImpl('shell')().get(params);
-  },
-  off: (type, handler) => {
-    return getImpl('shell')().off(type, handler);
-  },
-  on: (type, handler) => {
-    return getImpl('shell')().on(type, handler);
-  }
-} as ShellApi;
-
-export default shell;