@aotearoan/neon 23.0.2 → 23.2.0

package/dist/src/common/utils/NeonBannerService.d.ts

@@ -0,0 +1,47 @@
+import type { NeonBannerMessage } from '../models/NeonBannerMessage';
+import { NeonAlertLevel } from '../enums/NeonAlertLevel';
+/**
+ * NeonBannerService is a service for sending status banner notifications to the <strong>NeonBanner</strong> component for display to the user.
+ */
+export declare class NeonBannerService {
+    static readonly removeEventKey: string;
+    /**
+     * Send an info message.
+     *
+     * @param message The info message to display.
+     */
+    static info(message: NeonBannerMessage): void;
+    /**
+     * Send a success message.
+     *
+     * @param message The success message to display.
+     */
+    static success(message: NeonBannerMessage): void;
+    /**
+     * Send a warning message.
+     *
+     * @param message The warning message to display.
+     */
+    static warn(message: NeonBannerMessage): void;
+    /**
+     * Send an error message.
+     *
+     * @param message The error message to display.
+     */
+    static error(message: NeonBannerMessage): void;
+    /**
+     * Remove a message.
+     *
+     * @param key Key of the message to delete.
+     */
+    static remove(key: string): void;
+    /**
+     * Generate an event key so that all events are published on the correct topic.
+     *
+     * @param eventType Alert level of the event.
+     *
+     * @returns The event key for sending a message on <a href="/utils/NeonEventBus">NeonEventBus</a>.
+     */
+    static generateEventKey(eventType: NeonAlertLevel): string;
+    private static emit;
+}

package/dist/src/common/utils/NeonToastService.d.ts

@@ -5,6 +5,7 @@ import { NeonAlertLevel } from '../enums/NeonAlertLevel';
  * user.
  */
 export declare class NeonToastService {
+    static readonly removeEventKey: string;
     /**
      * Send an info message.
      *
@@ -29,6 +30,12 @@ export declare class NeonToastService {
      * @param toast Error toast message.
      */
     static error(toast: NeonToastMessage): void;
+    /**
+     * Remove a message.
+     *
+     * @param key Key of the message to delete.
+     */
+    static remove(key: string): void;
     /**
      * Generate an event key so that all events are published on the correct topic.
      *

package/dist/src/components/feedback/alert/NeonAlert.d.ts

@@ -27,6 +27,7 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
     topLeft: import("vue").Ref<{
         id: number;
         level: NeonAlertLevel;
+        key?: string | undefined;
         title?: string | undefined;
         message?: string | undefined;
         showIcon?: boolean | undefined;
@@ -44,6 +45,7 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
     }[], NeonAlertModel[] | {
         id: number;
         level: NeonAlertLevel;
+        key?: string | undefined;
         title?: string | undefined;
         message?: string | undefined;
         showIcon?: boolean | undefined;
@@ -62,6 +64,7 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
     topRight: import("vue").Ref<{
         id: number;
         level: NeonAlertLevel;
+        key?: string | undefined;
         title?: string | undefined;
         message?: string | undefined;
         showIcon?: boolean | undefined;
@@ -79,6 +82,7 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
     }[], NeonAlertModel[] | {
         id: number;
         level: NeonAlertLevel;
+        key?: string | undefined;
         title?: string | undefined;
         message?: string | undefined;
         showIcon?: boolean | undefined;
@@ -97,6 +101,7 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
     bottomLeft: import("vue").Ref<{
         id: number;
         level: NeonAlertLevel;
+        key?: string | undefined;
         title?: string | undefined;
         message?: string | undefined;
         showIcon?: boolean | undefined;
@@ -114,6 +119,7 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
     }[], NeonAlertModel[] | {
         id: number;
         level: NeonAlertLevel;
+        key?: string | undefined;
         title?: string | undefined;
         message?: string | undefined;
         showIcon?: boolean | undefined;
@@ -132,6 +138,7 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
     bottomRight: import("vue").Ref<{
         id: number;
         level: NeonAlertLevel;
+        key?: string | undefined;
         title?: string | undefined;
         message?: string | undefined;
         showIcon?: boolean | undefined;
@@ -149,6 +156,7 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
     }[], NeonAlertModel[] | {
         id: number;
         level: NeonAlertLevel;
+        key?: string | undefined;
         title?: string | undefined;
         message?: string | undefined;
         showIcon?: boolean | undefined;
@@ -167,6 +175,7 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
     top: import("vue").Ref<{
         id: number;
         level: NeonAlertLevel;
+        key?: string | undefined;
         title: string;
         placement?: NeonVerticalPosition | undefined;
         duration?: number | undefined;
@@ -174,6 +183,7 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
     }[], NeonToastModel[] | {
         id: number;
         level: NeonAlertLevel;
+        key?: string | undefined;
         title: string;
         placement?: NeonVerticalPosition | undefined;
         duration?: number | undefined;
@@ -182,6 +192,7 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
     bottom: import("vue").Ref<{
         id: number;
         level: NeonAlertLevel;
+        key?: string | undefined;
         title: string;
         placement?: NeonVerticalPosition | undefined;
         duration?: number | undefined;
@@ -189,6 +200,7 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
     }[], NeonToastModel[] | {
         id: number;
         level: NeonAlertLevel;
+        key?: string | undefined;
         title: string;
         placement?: NeonVerticalPosition | undefined;
         duration?: number | undefined;