@streamerly/sdk 0.0.1

package/dist/index.d.ts

@@ -0,0 +1 @@
+export * from "./types";

package/dist/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./types"), exports);

package/dist/types.d.ts

@@ -0,0 +1,83 @@
+/**
+ * EventListener
+ * Contains the onMessage and onAlert listener to register.
+ */
+export interface EventListener {
+    /**
+     * gets triggered on every live chat message from any configured platform.
+     * @param handler - the handler to work with the message
+     */
+    onMessage(handler: (platform: string, username: string, message: string) => void): () => void;
+    /**
+     * gets triggered on every live alert like "follower", "sub", "gift", etc. from any configured platform.
+     * @param handler - the handler to work with the alerts
+     */
+    onAlert(handler: (platform: string, username: string, title: string, message: string) => void): () => void;
+}
+/**
+ * RouteManager
+ * Contains the registerRoute to register routes
+ */
+export interface RouteManager {
+    /**
+     * registers a route
+     * Routing for plugin starts with http://localhost:8090/rest/plugin/$pluginKey/...
+     * @param method - the method of the route
+     * @param path
+     * @param handler - the handler to work with the message
+     */
+    registerRoute(method: "get" | "post" | "put" | "delete", path: string, handler: (req: any, res: any) => any): () => void;
+}
+/**
+ * WidgetManager
+ * Contains the registerDashboardWidget to register widgets
+ */
+export interface WidgetManager {
+    /**
+     * Registers a dashboard widget
+     * There must be a directory with the same name like the key and contains index.html and all needed css/js files
+     * @param key - the key of the widget
+     * @param title - the name of the widget
+     */
+    registerDashboardWidget(key: string, title: string): () => void;
+}
+/**
+ * TunnelManager
+ * Contains the onMessage to register to Tunnel-Frontend-Backend-Events and
+ * sendMessage to send a message from backend to frontend.
+ */
+export interface TunnelManager {
+    /**
+     * gets triggered on every tunnel message from the react frontend.
+     * @param handler - the handler to work with the message
+     */
+    onMessage(handler: (message: TunnelMessage) => void): void;
+    /**
+     * sends a tunnel message to the frontend
+     * @param message - the message
+     */
+    sendMessage(message: TunnelMessage): void;
+}
+/**
+ * The plugin context containing all register functions
+ * for rest, storage, websockets, listener, etc.
+ */
+export interface PluginContext {
+    id: string;
+    eventListener: EventListener;
+    routeManager: RouteManager;
+    widgetManager: WidgetManager;
+    tunnelManager: TunnelManager;
+}
+/**
+ * The abstract plugin definition to be registered.
+ */
+export interface Plugin {
+    register(ctx: PluginContext): void;
+}
+export interface TunnelMessage {
+    pluginKey: string;
+    type: string;
+    action: string;
+    jsonBody: any;
+}

package/dist/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -0,0 +1,17 @@
+{
+  "name": "@streamerly/sdk",
+  "version": "0.0.1",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "license": "MIT",
+  "scripts": {
+    "build": "tsc -p tsconfig.json"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "devDependencies": {
+    "typescript": "^5.0.0"
+  },
+  "dependencies": {}
+}

package/src/index.ts

@@ -0,0 +1 @@
+export * from "./types"

package/src/types.ts

@@ -0,0 +1,95 @@
+/**
+ * EventListener
+ * Contains the onMessage and onAlert listener to register.
+ */
+export interface EventListener {
+
+    /**
+     * gets triggered on every live chat message from any configured platform.
+     * @param handler - the handler to work with the message
+     */
+    onMessage(handler: (platform: string, username: string, message: string) => void): () => void;
+
+    /**
+     * gets triggered on every live alert like "follower", "sub", "gift", etc. from any configured platform.
+     * @param handler - the handler to work with the alerts
+     */
+    onAlert(handler: (platform: string, username: string, title: string, message: string) => void): () => void;
+}
+
+/**
+ * RouteManager
+ * Contains the registerRoute to register routes
+ */
+export interface RouteManager {
+
+    /**
+     * registers a route
+     * Routing for plugin starts with http://localhost:8090/rest/plugin/$pluginKey/...
+     * @param method - the method of the route
+     * @param path
+     * @param handler - the handler to work with the message
+     */
+    registerRoute(method: "get" | "post" | "put" | "delete", path: string, handler: (req: any, res: any) => any): () => void;
+}
+
+/**
+ * WidgetManager
+ * Contains the registerDashboardWidget to register widgets
+ */
+export interface WidgetManager {
+
+    /**
+     * Registers a dashboard widget
+     * There must be a directory with the same name like the key and contains index.html and all needed css/js files
+     * @param key - the key of the widget
+     * @param title - the name of the widget
+     */
+    registerDashboardWidget(key: string, title: string): () => void;
+}
+
+/**
+ * TunnelManager
+ * Contains the onMessage to register to Tunnel-Frontend-Backend-Events and
+ * sendMessage to send a message from backend to frontend.
+ */
+export interface TunnelManager {
+
+    /**
+     * gets triggered on every tunnel message from the react frontend.
+     * @param handler - the handler to work with the message
+     */
+    onMessage(handler: (message: TunnelMessage) => void): void;
+
+    /**
+     * sends a tunnel message to the frontend
+     * @param message - the message
+     */
+    sendMessage(message: TunnelMessage): void;
+}
+
+/**
+ * The plugin context containing all register functions
+ * for rest, storage, websockets, listener, etc.
+ */
+export interface PluginContext {
+    id: string;
+    eventListener: EventListener;
+    routeManager: RouteManager;
+    widgetManager: WidgetManager;
+    tunnelManager: TunnelManager;
+}
+
+/**
+ * The abstract plugin definition to be registered.
+ */
+export interface Plugin {
+    register(ctx: PluginContext): void;
+}
+
+export interface TunnelMessage {
+    pluginKey: string;
+    type: string;
+    action: string;
+    jsonBody: any;
+}

package/tsconfig.json

@@ -0,0 +1,10 @@
+{
+  "extends": "../tsconfig.base.json",
+  "compilerOptions": {
+    "rootDir": "src",
+    "outDir": "dist"
+  },
+  "include": [
+    "src"
+  ]
+}