buzzcasting-storage 2.3.1 → 2.5.0

package/dist/buzzcasting-storage.d.ts

@@ -40,7 +40,7 @@ export declare class BuzzcastingStorageReader {
     getSeries: (query: IQuery) => Promise<IResponse>;
 }
 
-declare interface Category {
+export declare interface Category {
     type: string;
     data: string[];
 }
@@ -49,7 +49,7 @@ export declare const CLOUD = "cloud";
 
 export declare const CLOUD_CSS = "color:grey;background-color:mistyrose;padding:0 4px 0 4px;border-radius:5px;";
 
-declare interface Current {
+declare interface CloudIndicators {
     total: number;
     positive: number;
     negative: number;
@@ -59,7 +59,7 @@ declare interface Current {
     velocity: number;
 }
 
-declare interface Dynamics {
+export declare interface Dynamics {
     engagement?: number;
     semrush_visits?: number;
     potential_reach?: number;
@@ -73,7 +73,7 @@ declare interface Dynamics {
     trending_score?: number;
 }
 
-declare interface Geo {
+export declare interface Geo {
     latitude: number;
     longitude: number;
     zip: string;
@@ -86,7 +86,10 @@ export declare const GET_DATA = "color:black;background-color:lime;padding:0 4px
 
 export declare const HIDE_CSS = "color:white;background-color:red;padding:0 4px 0 4px;border-radius:5px;";
 
-declare interface ICloud {
+/**
+ * Cloud
+ */
+export declare interface ICloud {
     labels: Label[];
     current: any[];
     previous: any[];
@@ -96,13 +99,13 @@ declare interface ICloud {
     previous_total: number;
 }
 
-declare interface IMessages {
+export declare interface IMessages {
     success?: boolean;
     message?: string;
     data?: Message[];
 }
 
-declare interface IMessagesData {
+export declare interface IMessagesData {
     messages: IMessages;
     presentation?: string;
     slide?: string;
@@ -110,11 +113,14 @@ declare interface IMessagesData {
     query: IQuery;
 }
 
-declare interface Indicators {
+export declare interface Indicators {
     value: number;
 }
 
-declare interface IQuery {
+/**
+ * Query
+ */
+export declare interface IQuery {
     [x: string]: any;
     topics?: string;
     dashboard?: string;
@@ -135,14 +141,20 @@ declare interface IQuery {
     hash?: string;
 }
 
-declare interface IResponse {
+/**
+ * API Response
+ */
+export declare interface IResponse {
     data: IMessagesData | ISeries | ICloud | null;
     message: string;
     success: boolean;
     query?: IQuery;
 }
 
-declare interface ISeries {
+/**
+ * Series Data
+ */
+export declare interface ISeries {
     topic: string;
     title: string;
     series: Series[];
@@ -152,12 +164,17 @@ declare interface ISeries {
     timestamp: number;
 }
 
-declare interface IStorageOptions {
+/**
+ * Storage Options
+ */
+export declare interface IStorageOptions {
     app: string;
+    domain?: string;
+    channel?: string;
+    presentation?: string;
+    slide?: string;
     version: string;
     storage: string;
-    slide: string;
-    presentation?: string;
     token?: string;
     bearer?: string;
     csrf?: string;
@@ -168,22 +185,22 @@ declare interface IStorageOptions {
     retention?: number;
 }
 
-declare interface Label {
+export declare interface Label {
     label: string;
     count: number;
     info: string;
-    current: Current;
-    previous: Previous;
+    current: CloudIndicators;
+    previous: CloudIndicators;
 }
 
-declare interface Medium {
+export declare interface Medium {
     type: string;
     url: string;
     width: number;
     height: number;
 }
 
-declare interface Message {
+export declare interface Message {
     id: string;
     published: string;
     harvested: string;
@@ -211,7 +228,7 @@ export declare const MESSAGES = "messages";
 
 export declare const MESSAGES_CSS = "color:grey;background-color:tan;padding:0 4px 0 4px;border-radius:5px;";
 
-declare interface Metrics {
+export declare interface Metrics {
     doc: number;
     previous: number;
     change: number;
@@ -223,17 +240,10 @@ export declare const NONE = "color:transparent;background-color:transparent;";
 
 export declare const PRESENTATION_CSS = "color:white;background-color:darkred;padding:0 4px 0 4px;border-radius:5px;";
 
-declare interface Previous {
-    total: number;
-    positive: number;
-    negative: number;
-    neutral: number;
-    engagement: number;
-    reach: number;
-    velocity: number;
-}
-
-declare interface Sender {
+/**
+ * Messages
+ */
+export declare interface Sender {
     id: string;
     title: string;
     name: string;
@@ -251,7 +261,7 @@ declare interface Sender {
 
 export declare const SERIES = "series";
 
-declare interface Series {
+export declare interface Series {
     name: string;
     label: string;
     current: number[];
@@ -282,7 +292,7 @@ export declare const SUBSCRIBE = "subscribe";
 
 export declare const SUBSCRIBE_CSS = "color:white;background-color:dodgerblue;padding:0 4px 0 4px;border-radius:5px;";
 
-declare interface Topic {
+export declare interface Topic {
     topic: string;
     engagement: number;
     impressions: number;
@@ -294,6 +304,33 @@ export declare const TOPICS = "topics";
 
 export declare const WIDGET = "widget";
 
+export declare class Widget {
+    private storageReader;
+    private broadcastChannel;
+    private query;
+    private readonly listeners;
+    /**
+     *
+     * @param callbacks functions in the widget that will receive the update
+     * @param query
+     */
+    constructor(callbacks: Array<(arg: IResponse) => void>, query: IQuery);
+    addListener(cb: (arg: IResponse) => void): void;
+    /**
+     * Data received from BroadcastChannel
+     * @param messageEvent
+     */
+    startListener(): void;
+    subscribe(): void;
+    getCloud: () => Promise<IResponse>;
+    getMessages: () => Promise<IResponse>;
+    getSeries: () => Promise<IResponse>;
+}
+
+export declare const WIDGET_CSS = "color:gret;background-color:lemonchiffon;padding:0 4px 0 4px;border-radius:5px;";
+
+export declare function widgetParams(query: IQuery): IQuery;
+
 export declare const WIDGETS = "widgets";
 
 export declare const WS_CSS = "color:white;background-color:green;padding:0 4px 0 4px;border-radius:5px;";