buzzcasting-storage 2.9.0 → 2.9.2

package/dist/buzzcasting-storage.d.ts

@@ -208,6 +208,15 @@ export declare interface IMetrics {
     change?: number;
 }
 
+/**
+ * IModal
+ */
+export declare interface IModal {
+    showComponent: string;
+    dataset?: any;
+    attributes?: any;
+}
+
 /**
  * Query
  */
@@ -317,8 +326,6 @@ export declare interface ITopic {
     sentiment: number;
 }
 
-export declare function messageId(e: MouseEvent, selector?: string): string | undefined;
-
 export declare enum MODERATION {
     APPROVED = "approved",
     BEFORE = "before",
@@ -335,6 +342,9 @@ export declare enum STORAGE {
     WINDOW = "window"
 }
 
+/**
+ * Main class for managing widgets and data updates
+ */
 export declare class Widget {
     private storageReader;
     private broadcastChannel;
@@ -342,9 +352,11 @@ export declare class Widget {
     private attributes;
     private listeners;
     /**
+     * Main container for managing widgets and data updates
      *
+     * @param element widget web component
      * @param callbacks functions in the widget that will receive the update
-     * @param query
+     * @param selector container for the element - by default buzzcasting-slide (optional)
      */
     constructor(element: HTMLElement, callbacks: Array<(arg: IResponse) => void>, selector?: string);
     addListener(cb: (arg: IResponse) => void): void;
@@ -352,15 +364,42 @@ export declare class Widget {
      * Data received from BroadcastChannel
      */
     startListener(): void;
+    /**
+     * This is used to register the component on the container's broadcast channel
+     * This takes place when the container indicates it has finished loading (ready)
+     */
     subscribe(): void;
+    /**
+     * Generic call to any query type
+     *
+     * @returns IResponse
+     */
+    getData: () => Promise<IResponse>;
+    /**
+     * Get Widget Coud Data
+     *
+     * @returns IResponse
+     */
     getCloud: () => Promise<IResponse>;
+    /**
+     * Get Widget Messages Data
+     *
+     * @returns IResponse
+     */
     getMessages: () => Promise<IResponse>;
+    /**
+     * Get Widget Series Data
+     *
+     * @returns IResponse
+     */
     getSeries: () => Promise<IResponse>;
-    showModal: (modal: {
-        showComponent: string;
-        dataset?: any;
-        attributes?: any;
-    }) => void;
+    /**
+     * Emit a show modal event using the element's attributes
+     * the component is the web component name to show
+     *
+     * @param modal IModal
+     */
+    showModal: (modal: IModal) => void;
     destroy(): void;
 }