@etsoo/notificationbase 1.1.52 → 1.1.54

package/src/Notification.ts

@@ -1,10 +1,10 @@
-import { DataTypes, Utils } from '@etsoo/shared';
+import { DataTypes, Utils } from "@etsoo/shared";
 
 // https://devimalplanet.com/typescript-how-to-extend-one-enum-from-another
 // Number index keys are still there
 const { MiddleLeft, MiddleRight, ...alignItems } = DataTypes.PlacementEnum;
 const newItems = {
-    ...alignItems
+  ...alignItems
 };
 delete newItems[MiddleLeft];
 delete newItems[MiddleRight];
@@ -13,41 +13,41 @@ delete newItems[MiddleRight];
  * Display align
  */
 export const NotificationAlign = {
-    ...newItems
+  ...newItems
 };
 export type NotificationAlign = Exclude<
-    DataTypes.PlacementEnum,
-    DataTypes.PlacementEnum.MiddleLeft | DataTypes.PlacementEnum.MiddleRight
+  DataTypes.PlacementEnum,
+  DataTypes.PlacementEnum.MiddleLeft | DataTypes.PlacementEnum.MiddleRight
 >;
 
 /**
  * Modal types
  */
 export enum NotificationModalType {
-    Loading = 0,
-    Confirm = 1,
-    Prompt = 2,
-    Error = 3, // Alert
-    Popup = 6
+  Loading = 0,
+  Confirm = 1,
+  Prompt = 2,
+  Error = 3, // Alert
+  Popup = 6
 }
 
 /**
  * Message types
  */
 export enum NotificationMessageType {
-    Default = 10, // No default then refer to Info
-    Success = 11,
-    Warning = 12,
-    Info = 13,
-    Danger = 14 // Error
+  Default = 10, // No default then refer to Info
+  Success = 11,
+  Warning = 12,
+  Info = 13,
+  Danger = 14 // Error
 }
 
 /**
  * Merged type definition below together
  */
 export const NotificationType = {
-    ...NotificationModalType,
-    ...NotificationMessageType
+  ...NotificationModalType,
+  ...NotificationMessageType
 };
 
 /**
@@ -64,14 +64,14 @@ export type NotificationContent<UI> = string | UI;
  * On dismiss callback
  */
 export interface NotificationDismiss {
-    (): void;
+  (): void;
 }
 
 /**
  * Notification reander setup
  */
 export interface NotifictionRenderSetup {
-    (options: any): any;
+  (options: any): any;
 }
 
 /**
@@ -81,47 +81,47 @@ export interface NotifictionRenderSetup {
  * return string is the error message to show
  */
 export interface NotificationReturn<T> {
-    (value: T): boolean | string | void | PromiseLike<boolean | string | void>;
+  (value: T): boolean | string | void | PromiseLike<boolean | string | void>;
 }
 
 /**
  * Notification message parameters
  */
 export interface NotificationParameters {
-    /**
-     * Display align
-     */
-    align?: NotificationAlign;
-
-    /**
-     * Callback
-     */
-    callback?: NotificationReturn<void>;
-
-    /**
-     * Show as modal
-     */
-    modal?: boolean;
-
-    /**
-     * Time span to dismiss
-     */
-    timespan?: number;
-
-    /**
-     * Add to the top
-     */
-    top?: boolean;
+  /**
+   * Display align
+   */
+  align?: NotificationAlign;
+
+  /**
+   * Callback
+   */
+  callback?: NotificationReturn<void>;
+
+  /**
+   * Show as modal
+   */
+  modal?: boolean;
+
+  /**
+   * Time span to dismiss
+   */
+  timespan?: number;
+
+  /**
+   * Add to the top
+   */
+  top?: boolean;
 }
 
 /**
  * Notification props supported for calls
  */
 export type NotificationCallProps = {
-    /**
-     * Input component properties
-     */
-    inputProps?: DataTypes.StringRecord;
+  /**
+   * Input component properties
+   */
+  inputProps?: DataTypes.StringRecord;
 };
 
 /**
@@ -133,131 +133,131 @@ export type NotificationRenderProps = DataTypes.StringRecord;
  * Notification base interface
  */
 export interface INotificaseBase<UI, C extends NotificationCallProps = {}> {
-    /**
-     * Display align
-     */
-    readonly align?: NotificationAlign;
-
-    /**
-     * Content
-     */
-    readonly content: NotificationContent<UI>;
-
-    /**
-     * Input or control properties
-     */
-    inputProps?: C;
-
-    /**
-     * On dismiss handling
-     */
-    onDismiss?: NotificationDismiss;
-
-    /**
-     * On return value
-     */
-    onReturn?: NotificationReturn<any>;
-
-    /**
-     * Show the icon or hide it
-     */
-    showIcon?: boolean;
-
-    /**
-     * Seconds to auto dismiss
-     */
-    timespan?: number;
-
-    /**
-     * Render setup / callback
-     * Add more properties
-     */
-    renderSetup?: NotifictionRenderSetup;
-
-    /**
-     * Title
-     */
-    readonly title?: NotificationContent<UI>;
-
-    /**
-     * Type
-     */
-    readonly type: NotificationType;
+  /**
+   * Display align
+   */
+  readonly align?: NotificationAlign;
+
+  /**
+   * Content
+   */
+  readonly content: NotificationContent<UI>;
+
+  /**
+   * Input or control properties
+   */
+  inputProps?: C;
+
+  /**
+   * On dismiss handling
+   */
+  onDismiss?: NotificationDismiss;
+
+  /**
+   * On return value
+   */
+  onReturn?: NotificationReturn<any>;
+
+  /**
+   * Show the icon or hide it
+   */
+  showIcon?: boolean;
+
+  /**
+   * Seconds to auto dismiss
+   */
+  timespan?: number;
+
+  /**
+   * Render setup / callback
+   * Add more properties
+   */
+  renderSetup?: NotifictionRenderSetup;
+
+  /**
+   * Title
+   */
+  readonly title?: NotificationContent<UI>;
+
+  /**
+   * Type
+   */
+  readonly type: NotificationType;
 }
 
 /**
  * Notification interface
  */
 export interface INotification<UI, C extends NotificationCallProps>
-    extends INotificaseBase<UI, C> {
-    /**
-     * Display align
-     */
-    readonly align: NotificationAlign;
-
-    /**
-     * Seconds to auto dismiss
-     */
-    timespan: number;
-
-    /**
-     * Unique id
-     */
-    readonly id: string;
-
-    /**
-     * Display as modal
-     */
-    modal: boolean;
-
-    /**
-     * Is open or not
-     */
-    readonly open: boolean;
-
-    /**
-     * Reference
-     */
-    ref?: any;
-
-    /**
-     * Content
-     */
-    readonly content: NotificationContent<UI>;
-
-    /**
-     * Title
-     */
-    readonly title?: NotificationContent<UI>;
-
-    /**
-     * Dismiss it
-     * @param delaySeconds Delay seconds
-     * @param noTrigger No onReturn trigger
-     * @returns Is delayed or not
-     */
-    dismiss(delaySeconds?: number, noTrigger?: boolean): boolean;
-
-    /**
-     * Dispose it
-     */
-    dispose(): void;
-
-    /**
-     * Render method
-     * @param props Props
-     * @param className Style class name
-     * @param options Other options
-     */
-    render(props: NotificationRenderProps, className?: string): UI | undefined;
-
-    /**
-     * Return value
-     * Dismiss first, then run callback
-     * @param value
-     * @returns
-     */
-    returnValue(value: any): Promise<void>;
+  extends INotificaseBase<UI, C> {
+  /**
+   * Display align
+   */
+  readonly align: NotificationAlign;
+
+  /**
+   * Seconds to auto dismiss
+   */
+  timespan: number;
+
+  /**
+   * Unique id
+   */
+  readonly id: string;
+
+  /**
+   * Display as modal
+   */
+  modal: boolean;
+
+  /**
+   * Is open or not
+   */
+  readonly open: boolean;
+
+  /**
+   * Reference
+   */
+  ref?: any;
+
+  /**
+   * Content
+   */
+  readonly content: NotificationContent<UI>;
+
+  /**
+   * Title
+   */
+  readonly title?: NotificationContent<UI>;
+
+  /**
+   * Dismiss it
+   * @param delaySeconds Delay seconds
+   * @param noTrigger No onReturn trigger
+   * @returns Is delayed or not
+   */
+  dismiss(delaySeconds?: number, noTrigger?: boolean): boolean;
+
+  /**
+   * Dispose it
+   */
+  dispose(): void;
+
+  /**
+   * Render method
+   * @param props Props
+   * @param className Style class name
+   * @param options Other options
+   */
+  render(props: NotificationRenderProps, className?: string): UI | undefined;
+
+  /**
+   * Return value
+   * Dismiss first, then run callback
+   * @param value
+   * @returns
+   */
+  returnValue(value: any): Promise<void>;
 }
 
 /**
@@ -265,197 +265,197 @@ export interface INotification<UI, C extends NotificationCallProps>
  * Generic parameter UI presents UI element type
  */
 export abstract class Notification<UI, C extends NotificationCallProps>
-    implements INotification<UI, C>
+  implements INotification<UI, C>
 {
-    /**
-     * Display align
-     */
-    readonly align: NotificationAlign;
-
-    /**
-     * Content
-     */
-    readonly content: NotificationContent<UI>;
-
-    /**
-     * Dismiss timeout seed
-     */
-    private dismissSeed: number = 0;
-
-    /**
-     * Unique id
-     */
-    readonly id: string;
-
-    /**
-     * Input or control properties
-     */
-    inputProps?: C;
-
-    /**
-     * Display as modal
-     */
-    modal: boolean;
-
-    /**
-     * On dismiss handling
-     */
-    onDismiss?: NotificationDismiss;
-
-    /**
-     * On return value
-     */
-    onReturn?: NotificationReturn<unknown>;
-
-    private _open: boolean = true;
-    /**
-     * Is open or not
-     */
-    get open(): boolean {
-        return this._open;
+  /**
+   * Display align
+   */
+  readonly align: NotificationAlign;
+
+  /**
+   * Content
+   */
+  readonly content: NotificationContent<UI>;
+
+  /**
+   * Dismiss timeout seed
+   */
+  private dismissSeed: number = 0;
+
+  /**
+   * Unique id
+   */
+  readonly id: string;
+
+  /**
+   * Input or control properties
+   */
+  inputProps?: C;
+
+  /**
+   * Display as modal
+   */
+  modal: boolean;
+
+  /**
+   * On dismiss handling
+   */
+  onDismiss?: NotificationDismiss;
+
+  /**
+   * On return value
+   */
+  onReturn?: NotificationReturn<unknown>;
+
+  private _open: boolean = true;
+  /**
+   * Is open or not
+   */
+  get open(): boolean {
+    return this._open;
+  }
+
+  /**
+   * Reference
+   */
+  ref?: any;
+
+  /**
+   * Render setup / callback
+   */
+  renderSetup?: NotifictionRenderSetup;
+
+  /**
+   * Show the icon or hide it
+   */
+  showIcon?: boolean;
+
+  /**
+   * Seconds to auto dismiss
+   */
+  timespan: number;
+
+  /**
+   * Title
+   */
+  readonly title?: NotificationContent<UI>;
+
+  /**
+   * Type
+   */
+  readonly type: NotificationType;
+
+  /**
+   * Constructor
+   * @param type Type
+   * @param content Content
+   * @param title Title
+   * @param align Align
+   * @param timespan Timespan
+   */
+  constructor(
+    type: NotificationType,
+    content: NotificationContent<UI>,
+    title?: NotificationContent<UI>,
+    align?: NotificationAlign,
+    timespan?: number
+  ) {
+    this.id = Utils.newGUID();
+
+    this.type = type;
+    this.content = content;
+    this.title = title;
+
+    // Modal type
+    this.modal = type in NotificationModalType;
+
+    // Align, only available for none modal
+    if (this.modal) this.align = NotificationAlign.Unknown;
+    else if (align != null) this.align = align;
+    // Message align default to top left
+    else if (type in NotificationMessageType)
+      this.align = NotificationAlign.TopLeft;
+    else this.align = NotificationAlign.Center;
+
+    // Display as modal will lasts otherwise 5 seconds to dismiss it
+    this.timespan = timespan ?? (this.modal ? 0 : 5);
+  }
+
+  /**
+   * Dismiss it
+   * @param delaySeconds Delay seconds
+   * @param noTrigger No onReturn trigger
+   * @returns Is delayed or not
+   */
+  dismiss(delaySeconds: number = 0, noTrigger: boolean = false): boolean {
+    // If it's closed, return
+    if (!this._open) return false;
+
+    if (delaySeconds > 0) {
+      this.removeTimeout();
+      this.dismissSeed = window.setTimeout(
+        this.dismiss.bind(this),
+        delaySeconds * 1000,
+        0 // force to dismiss
+      );
+      return true;
     }
 
-    /**
-     * Reference
-     */
-    ref?: any;
-
-    /**
-     * Render setup / callback
-     */
-    renderSetup?: NotifictionRenderSetup;
-
-    /**
-     * Show the icon or hide it
-     */
-    showIcon?: boolean;
-
-    /**
-     * Seconds to auto dismiss
-     */
-    timespan: number;
-
-    /**
-     * Title
-     */
-    readonly title?: NotificationContent<UI>;
-
-    /**
-     * Type
-     */
-    readonly type: NotificationType;
-
-    /**
-     * Constructor
-     * @param type Type
-     * @param content Content
-     * @param title Title
-     * @param align Align
-     * @param timespan Timespan
-     */
-    constructor(
-        type: NotificationType,
-        content: NotificationContent<UI>,
-        title?: NotificationContent<UI>,
-        align?: NotificationAlign,
-        timespan?: number
+    // For message, call onReturn
+    if (
+      !noTrigger &&
+      this.onReturn != null &&
+      this.type in NotificationMessageType
     ) {
-        this.id = Utils.newGUID();
-
-        this.type = type;
-        this.content = content;
-        this.title = title;
+      this.onReturn(undefined);
+    }
 
-        // Modal type
-        this.modal = type in NotificationModalType;
+    // Indicate closed
+    this._open = false;
 
-        // Align, only available for none modal
-        if (this.modal) this.align = NotificationAlign.Unknown;
-        else if (align != null) this.align = align;
-        // Message align default to top left
-        else if (type in NotificationMessageType)
-            this.align = NotificationAlign.TopLeft;
-        else this.align = NotificationAlign.Center;
+    if (this.onDismiss) this.onDismiss();
 
-        // Display as modal will lasts otherwise 5 seconds to dismiss it
-        this.timespan = timespan ?? (this.modal ? 0 : 5);
-    }
+    this.dispose();
 
-    /**
-     * Dismiss it
-     * @param delaySeconds Delay seconds
-     * @param noTrigger No onReturn trigger
-     * @returns Is delayed or not
-     */
-    dismiss(delaySeconds: number = 0, noTrigger: boolean = false): boolean {
-        // If it's closed, return
-        if (!this._open) return false;
-
-        if (delaySeconds > 0) {
-            this.removeTimeout();
-            this.dismissSeed = window.setTimeout(
-                this.dismiss.bind(this),
-                delaySeconds * 1000,
-                0 // force to dismiss
-            );
-            return true;
-        }
-
-        // For message, call onReturn
-        if (
-            !noTrigger &&
-            this.onReturn != null &&
-            this.type in NotificationMessageType
-        ) {
-            this.onReturn(undefined);
-        }
-
-        // Indicate closed
-        this._open = false;
-
-        if (this.onDismiss) this.onDismiss();
-
-        this.dispose();
-
-        return false;
-    }
+    return false;
+  }
 
-    // Remove possible dismiss timeout
-    private removeTimeout() {
-        if (this.dismissSeed > 0) {
-            clearTimeout(this.dismissSeed);
-            this.dismissSeed = 0;
-        }
+  // Remove possible dismiss timeout
+  private removeTimeout() {
+    if (this.dismissSeed > 0) {
+      clearTimeout(this.dismissSeed);
+      this.dismissSeed = 0;
     }
-
-    /**
-     * Dispose it
-     */
-    dispose() {
-        this.removeTimeout();
-    }
-
-    /**
-     * Render method
-     * @param props Props, provider's UI props
-     * @param className Style class name
-     */
-    abstract render(
-        props: NotificationRenderProps,
-        className?: string
-    ): UI | undefined;
-
-    /**
-     * Return value
-     * Dismiss first, then run callback
-     * @param value
-     * @returns
-     */
-    async returnValue(value: any) {
-        if (this.onReturn) {
-            const result = await this.onReturn(value);
-            if (result === false) return;
-        }
-        this.dismiss(0, true);
+  }
+
+  /**
+   * Dispose it
+   */
+  dispose() {
+    this.removeTimeout();
+  }
+
+  /**
+   * Render method
+   * @param props Props, provider's UI props
+   * @param className Style class name
+   */
+  abstract render(
+    props: NotificationRenderProps,
+    className?: string
+  ): UI | undefined;
+
+  /**
+   * Return value
+   * Dismiss first, then run callback
+   * @param value
+   * @returns
+   */
+  async returnValue(value: any) {
+    if (this.onReturn) {
+      const result = await this.onReturn(value);
+      if (result === false) return;
     }
+    this.dismiss(0, true);
+  }
 }