buzzcasting-storage 1.0.3 → 1.0.6

package/README.md

@@ -2,6 +2,8 @@
 
 This is a wrapper class to use multiple storage options with BuzzCasting.
 
+BuzzCasting Social Media Wall & Dataviz [More info](https://www.touchflows.com/services-buzzcasting-social-media-wall/).
+
 Currently supported are: Local Storage, Session Storage, IDB Keyval, Dexie, Window object
 
 ## Features
@@ -17,37 +19,61 @@ Currently supported are: Local Storage, Session Storage, IDB Keyval, Dexie, Wind
 ## Get started
 
 Example call:
+
 ```js
-import BuzzcastingStorageManager, { IQuery, IStorageManager } from 'buzzcasting-storage'
+import BuzzcastingStorageManager, {
+  IQuery,
+  IStorageManager,
+  IMessages,
+} from "buzzcasting-storage";
 
 const options: IStorageManager = {
-  app: 'my-subdomain',
-  version: 'v4',
-  token: 'meta',
-  bearer: 'bearer_token',
-  storage: 'dexie',
-  moderation: 'none',
+  app: "my-subdomain",
+  version: "v4",
+  token: "meta",
+  bearer: "bearer_token",
+  storage: "dexie",
+  moderation: "none",
   beforeTime: null,
   delay: 0,
   period: 0,
 };
 
-let storageManager = new BuzzcastingStorageManager(options)
+let storageManager = new BuzzcastingStorageManager(options);
 
 const query: IQuery = {
-  type: 'messages',
-  dashboard: 'dashboard_id',
-  widget: 'widget_id'
-}
+  type: "messages",
+  dashboard: "dashboard_id",
+  widget: "widget_id",
+};
 
-const data = storageManager.getMessages(query)
+const data: IMessages = storageManager.getMessages(query);
 ```
 
 This will initiate a call to the buzzcasting backoffice to retrieve results
 
-### GitHub Template
+The Storage Manager will carry out the API call for the subscriber, and send out a BroadcastChannel on `app` to inform the subcriber that it can retrieve new data. The broadcast channel facilitates its incorporation in for example a Web Worker.
 
-This is a template repo. Click the green [Use this template](https://github.com/hywax/vite-vanilla-library-template/generate) button to get started.
+```js
+
+const broadcastChannel = new BroadcastChannel('my-subdomain')
+
+broadcastChannel.onmessage = (messageEvent: MessageEvent) => {
+  this.actions(messageEvent)
+}
+
+actions = (messageEvent: MessageEvent) => {
+  switch (messageEvent.data.event) {
+    case 'widget-update':
+      // handle update
+      this.widgetUpdated.emit(messageEvent.data.data)
+      break
+    default:
+      //console.log('[storage]', messageEvent.data)
+  }
+}
+
+```
 
 ### Git Clone
 
@@ -55,7 +81,7 @@ This is a template repo. Click the green [Use this template](https://github.com/
 git clone https://github.com/TouchFlows/buzzcasting-storage.git
 cd buzzcasting-storage
 pnpm install
-```
+````
 
 ## Usage
 

package/dist/buzzcasting-storage.d.ts

@@ -15,27 +15,57 @@ declare class BuzzcastingStorageManager {
 }
 export default BuzzcastingStorageManager;
 
-declare interface IQuery {
+export declare const CLOUD = "cloud";
+
+export declare interface Dynamics {
+    uniquecomments: number;
+    engagement: number;
+    likesandvotes: number;
+    viewcount: number;
+    inboundlinks: number;
+    forumthread: number;
+    shares: number;
+    favourite: number;
+    semrush_visits?: number;
+    potential_reach?: number;
+}
+
+export declare interface Geo {
+    latitude: number;
+    longitude: number;
+    zip: string;
+    street: string;
+    city: string;
+    country: string;
+}
+
+export declare interface IMessages {
+    success?: boolean;
+    message?: string;
+    data?: Message[];
+}
+
+export declare interface IQuery {
     [x: string]: any;
     topics?: string;
     dashboard?: string;
     widget?: string;
     compare?: string;
     period?: number;
-    type?: 'cloud' | 'messages' | 'indicators' | 'proxy';
+    type?: "cloud" | "messages" | "indicators" | "proxy";
     order?: string;
     media?: number;
     dynamics?: number;
     geo?: number;
     delay?: string;
     approved?: string;
-    moderation?: 'realtime' | 'delayed' | 'approved';
+    moderation?: "realtime" | "delayed" | "approved";
     hrm?: string;
     before?: number;
     since?: number;
 }
 
-declare interface IStorageManager {
+export declare interface IStorageManager {
     app: string;
     version: string;
     storage: string;
@@ -51,4 +81,75 @@ declare interface IStorageManager {
     retention?: number;
 }
 
+export declare interface Medium {
+    type: string;
+    url: string;
+    width: number;
+    height: number;
+}
+
+export declare interface Message {
+    id: string;
+    published: string;
+    harvested: string;
+    utc: number;
+    channel: string;
+    type: string;
+    sender: Sender;
+    reply: string;
+    replyto: string;
+    page: string;
+    conversation: string;
+    title: string;
+    content: string;
+    sentiment: number;
+    link: string;
+    language: string;
+    region: string;
+    topics: Topic[];
+    dynamics?: Dynamics;
+    geo?: Geo;
+    media?: Medium[];
+}
+
+export declare const MESSAGES = "messages";
+
+export declare interface Sender {
+    id: string;
+    title: string;
+    name: string;
+    avatar: string;
+    bio: string;
+    location: string;
+    verified: number;
+    following: number;
+    followers: number;
+    listed: number;
+    favourites: number;
+    messages: number;
+    influence: number;
+}
+
+export declare const SERIES = "series";
+
+export declare const STORAGE_DEXIE = "dexie";
+
+export declare const STORAGE_KEYVAL = "keyval";
+
+export declare const STORAGE_LOCAL = "local";
+
+export declare const STORAGE_SESSION = "session";
+
+export declare const STORAGE_WINDOW = "window";
+
+export declare interface Topic {
+    topic: string;
+    engagement: number;
+    impressions: number;
+    reach: number;
+    sentiment: number;
+}
+
+export declare const TOPICS = "topics";
+
 export { }