@kash-88/alerts 1.2.1 → 1.3.0

package/dist/src/WebSocket/CentrifugeClient.js

@@ -0,0 +1,216 @@
+import getPrivateToken from "../Function/getPrivateToken.js";
+import getUser from "../Function/getUser.js";
+import getUserChannel from "../Function/getUserChannel.js";
+import { formatAxiosError } from "../utils.js";
+import { WebSocket } from "ws";
+import { EventEmitter } from "events";
+/**
+ * Class for interacting with Centrifuge donationalerts
+ *
+ * @param {WSClientOptions} options - Connection options
+ * @param {string} options.access_token - User access token
+ * @param {string[]} [options.channels] - Custom channels to subscribe to (defaults to donation channel)
+ * @param {boolean} [options.autoReconnect=false] - Automatically reconnect on connection close
+ */
+export default class CentrifugeClient extends EventEmitter {
+    constructor(options) {
+        super();
+        this.access_token = options.access_token;
+        this.channels = options.channels ?? [];
+        this.autoReconnect = options.autoReconnect ?? false;
+        this.isAuthorized = false;
+        this.reconnectTimer = null;
+        this.isReconnecting = false;
+        this.authMessageHandler = null;
+        this.WebSocket = null;
+        this.user = null;
+        this.userPromise = this.getUser(this.access_token).catch((error) => {
+            this.emit("error", error);
+            throw error;
+        });
+        this.createNewConnection();
+        this.setupEvent();
+    }
+    /**
+     * Obtain user data
+     *
+     * @param {string} access_token - User access token
+     * @returns {Promise<User>} User data
+     */
+    async getUser(access_token) {
+        try {
+            this.user = await getUser(access_token);
+            return this.user;
+        }
+        catch (error) {
+            throw new Error(formatAxiosError(error));
+        }
+    }
+    /**
+     * Get channels to subscribe to
+     *
+     * @returns {Promise<string[]>} Array of channel identifiers
+     */
+    async getChannels() {
+        if (!this.user?.id)
+            this.user = await (this.userPromise ?? this.getUser(this.access_token));
+        if (!this.user?.id)
+            throw new Error("Failed to get channels due to missing user ID");
+        if (this.channels.length > 0)
+            return this.channels;
+        return [getUserChannel(this.user.id)];
+    }
+    /**
+     * Create a new WebSocket connection
+     */
+    createNewConnection() {
+        try {
+            if (this.WebSocket)
+                return;
+            this.WebSocket = new WebSocket("wss://centrifugo.donationalerts.com/connection/websocket");
+        }
+        catch (error) {
+            throw new Error(error?.message || error);
+        }
+    }
+    /**
+     * Forward events through a TypedEmitter
+     */
+    setupEvent() {
+        if (!this.WebSocket) {
+            this.createNewConnection();
+            if (!this.WebSocket)
+                throw new Error("WebSocket connection failed");
+        }
+        const ws = this.WebSocket;
+        ws.on('open', () => {
+            this.emit("open");
+        });
+        ws.on('close', (code, reason) => {
+            this.isAuthorized = false;
+            this.emit("close", code, reason);
+            if (this.autoReconnect) {
+                this.WebSocket = null;
+                if (this.reconnectTimer)
+                    clearTimeout(this.reconnectTimer);
+                this.isReconnecting = true;
+                this.reconnectTimer = setTimeout(() => {
+                    this.isReconnecting = false;
+                    this.createNewConnection();
+                    this.setupEvent();
+                    this.emit("reconnect");
+                }, 5000);
+            }
+        });
+        ws.on('message', (rawMessage) => {
+            try {
+                const message = JSON.parse(rawMessage.toString());
+                this.emit("message", message);
+            }
+            catch (error) {
+                this.emit("error", new Error(`Failed to parse WebSocket message: ${error?.message || error}`));
+            }
+        });
+        ws.on('error', (error) => {
+            this.emit("error", error);
+        });
+    }
+    /**
+     * Authorize WebSocket and subscribe to selected channels
+     */
+    async authorization() {
+        if (this.isReconnecting) {
+            throw new Error("Reconnection is in progress, please wait for the 'reconnect' event");
+        }
+        if (!this.WebSocket)
+            this.createNewConnection();
+        if (!this.WebSocket)
+            throw new Error("WebSocket connection failed");
+        if (this.WebSocket.readyState !== WebSocket.OPEN) {
+            throw new Error("WebSocket connection is not open. Call authorization() after the 'open' event");
+        }
+        if (!this.user)
+            this.user = await (this.userPromise ?? this.getUser(this.access_token));
+        if (!this.user?.socket_connection_token)
+            throw new Error("Failed to log in due to receiving socket connection token");
+        if (this.authMessageHandler) {
+            this.WebSocket?.removeListener('message', this.authMessageHandler);
+        }
+        const handleAuthResponse = async (rawMessage) => {
+            try {
+                const json = JSON.parse(rawMessage.toString());
+                if (json.id === 1) {
+                    this.authMessageHandler = null;
+                    this.WebSocket?.removeListener('message', handleAuthResponse);
+                    if (!json.result?.client) {
+                        this.emit("error", new Error("Authorization failed: missing client ID in response"));
+                        return;
+                    }
+                    const channels = await this.getChannels();
+                    for (let i = 0; i < channels.length; i++) {
+                        const channel = channels[i];
+                        const privateToken = await getPrivateToken(channel, json.result.client, this.access_token);
+                        this.sendMessage(JSON.stringify({
+                            id: 2 + i,
+                            method: 1,
+                            params: {
+                                channel,
+                                token: privateToken
+                            }
+                        }));
+                    }
+                    this.isAuthorized = true;
+                }
+            }
+            catch (error) {
+                this.authMessageHandler = null;
+                this.WebSocket?.removeListener('message', handleAuthResponse);
+                this.emit("error", new Error(`Authorization failed: ${error?.message || error}`));
+            }
+        };
+        this.authMessageHandler = handleAuthResponse;
+        this.WebSocket.on('message', handleAuthResponse);
+        this.sendMessage(JSON.stringify({
+            params: {
+                token: this.user.socket_connection_token
+            },
+            id: 1
+        }));
+    }
+    /**
+     * Send a message through the WebSocket connection
+     *
+     * @param {string} message - JSON-encoded message to send
+     */
+    sendMessage(message) {
+        try {
+            if (!this.WebSocket)
+                return;
+            if (this.WebSocket.readyState !== WebSocket.OPEN)
+                return;
+            this.WebSocket.send(message);
+        }
+        catch (error) {
+            throw new Error(error?.message || error);
+        }
+    }
+    /**
+     * Close the WebSocket connection and stop auto-reconnect
+     */
+    close() {
+        this.autoReconnect = false;
+        if (this.reconnectTimer) {
+            clearTimeout(this.reconnectTimer);
+            this.reconnectTimer = null;
+        }
+        if (this.WebSocket) {
+            if (this.authMessageHandler) {
+                this.WebSocket.removeListener('message', this.authMessageHandler);
+                this.authMessageHandler = null;
+            }
+            this.WebSocket.close();
+            this.WebSocket = null;
+        }
+        this.isAuthorized = false;
+    }
+}

package/dist/src/index.d.ts

@@ -1,9 +1,18 @@
-import getAuthorizeLink from "./func/getAuthorizeLink.js";
-import getOauthToken from "./func/getOauthToken.js";
-import getUser from "./func/getUser.js";
-import updateAccessToken from "./func/updateAccessToken.js";
-import getUserChannel from "./func/getUserChannel.js";
-import { getPrivateToken } from "./func/getPrivateToken.js";
-import CentrifugeClient from "./ws/CentrifugeClient.js";
-export * from "./types.js";
-export { getAuthorizeLink, getOauthToken, getUser, updateAccessToken, getUserChannel, getPrivateToken, CentrifugeClient };
+import getAuthorizeLink from "./Function/getAuthorizeLink.js";
+import getOauthToken from "./Function/getOauthToken.js";
+import getUser from "./Function/getUser.js";
+import updateOauthToken from "./Function/updateOauthToken.js";
+import getUserChannel from "./Function/getUserChannel.js";
+import getPrivateToken from "./Function/getPrivateToken.js";
+import getDonationsAlerts from "./Function/getDonationsAlerts.js";
+import getExternal from "./Function/getExternal.js";
+import createCustomAlerts from "./Function/createCustomAlerts.js";
+import generateSignature from "./Function/generateSignature.js";
+import createMerchandise from "./Function/createMerchandise.js";
+import updateMerchandise from "./Function/updateMerchandise.js";
+import updateOrCreateMerchandise from "./Function/updateOrCreateMerchandise.js";
+import getUserDataFromPromocode from "./Function/getUserDataFromPromocode.js";
+import sendSaleAlert from "./Function/sendSaleAlert.js";
+import WebServer from "./WebSocket/CentrifugeClient.js";
+import { OAuthScope } from "./Types/index.js";
+export { getAuthorizeLink, getOauthToken, getUser, updateOauthToken, getUserChannel, getExternal, getPrivateToken, getDonationsAlerts, createCustomAlerts, generateSignature, createMerchandise, updateMerchandise, updateOrCreateMerchandise, getUserDataFromPromocode, sendSaleAlert, WebServer, OAuthScope };

package/dist/src/index.js

@@ -1,9 +1,18 @@
-import getAuthorizeLink from "./func/getAuthorizeLink.js";
-import getOauthToken from "./func/getOauthToken.js";
-import getUser from "./func/getUser.js";
-import updateAccessToken from "./func/updateAccessToken.js";
-import getUserChannel from "./func/getUserChannel.js";
-import { getPrivateToken } from "./func/getPrivateToken.js";
-import CentrifugeClient from "./ws/CentrifugeClient.js";
-export * from "./types.js";
-export { getAuthorizeLink, getOauthToken, getUser, updateAccessToken, getUserChannel, getPrivateToken, CentrifugeClient };
+import getAuthorizeLink from "./Function/getAuthorizeLink.js";
+import getOauthToken from "./Function/getOauthToken.js";
+import getUser from "./Function/getUser.js";
+import updateOauthToken from "./Function/updateOauthToken.js";
+import getUserChannel from "./Function/getUserChannel.js";
+import getPrivateToken from "./Function/getPrivateToken.js";
+import getDonationsAlerts from "./Function/getDonationsAlerts.js";
+import getExternal from "./Function/getExternal.js";
+import createCustomAlerts from "./Function/createCustomAlerts.js";
+import generateSignature from "./Function/generateSignature.js";
+import createMerchandise from "./Function/createMerchandise.js";
+import updateMerchandise from "./Function/updateMerchandise.js";
+import updateOrCreateMerchandise from "./Function/updateOrCreateMerchandise.js";
+import getUserDataFromPromocode from "./Function/getUserDataFromPromocode.js";
+import sendSaleAlert from "./Function/sendSaleAlert.js";
+import WebServer from "./WebSocket/CentrifugeClient.js";
+import { OAuthScope } from "./Types/index.js";
+export { getAuthorizeLink, getOauthToken, getUser, updateOauthToken, getUserChannel, getExternal, getPrivateToken, getDonationsAlerts, createCustomAlerts, generateSignature, createMerchandise, updateMerchandise, updateOrCreateMerchandise, getUserDataFromPromocode, sendSaleAlert, WebServer, OAuthScope };

package/dist/src/utils.d.ts

@@ -1,15 +1,7 @@
 /**
- * Checks if a value is a plain object.
- * @param {unknown} value The value to check.
- * @returns {boolean} True if the value is a plain object, false otherwise.
- * @private
+ * Format an axios error into a readable error message.
+ *
+ * @param {any} error - The error thrown by axios or any other source
+ * @returns {string} A formatted error message
  */
-/**
- * Validates that the provided data is an object and contains the required keys.
- * For each required key, it also validates that the value is a string or a number.
- * @param {unknown} data - The data object to validate.
- * @param {string[]} requiredKeys - An array of keys that must be present in the data object.
- * @throws {Error} If validation fails.
- * @private
- */
-export declare function validateDataObject(data: unknown, requiredKeys: string[]): asserts data is Record<string, string | number | string[]>;
+export declare function formatAxiosError(error: any): string;

package/dist/src/utils.js

@@ -1,37 +1,21 @@
 /**
- * Checks if a value is a plain object.
- * @param {unknown} value The value to check.
- * @returns {boolean} True if the value is a plain object, false otherwise.
- * @private
+ * Format an axios error into a readable error message.
+ *
+ * @param {any} error - The error thrown by axios or any other source
+ * @returns {string} A formatted error message
  */
-function isObject(value) {
-    return typeof value === "object" && value !== null && !Array.isArray(value);
-}
-/**
- * Validates that the provided data is an object and contains the required keys.
- * For each required key, it also validates that the value is a string or a number.
- * @param {unknown} data - The data object to validate.
- * @param {string[]} requiredKeys - An array of keys that must be present in the data object.
- * @throws {Error} If validation fails.
- * @private
- */
-export function validateDataObject(data, requiredKeys) {
-    if (!isObject(data)) {
-        throw new Error("You must provide data as an object.");
+export function formatAxiosError(error) {
+    if (error?.response?.data?.error_description) {
+        return error.response.data.error_description;
+    }
+    if (error?.response?.data?.message) {
+        return error.response.data.message;
+    }
+    if (error?.response?.data?.error) {
+        return error.response.data.error;
     }
-    for (const key of requiredKeys) {
-        if (!(key in data) || data[key] === undefined || data[key] === null) {
-            throw new Error(`You must provide "${key}" in the data object.`);
-        }
-        const value = data[key];
-        if (key === "scope") {
-            if (!Array.isArray(value)) {
-                throw new Error(`"${key}" must be an array of strings.`);
-            }
-            continue;
-        }
-        if (typeof value !== "string" && typeof value !== "number") {
-            throw new Error(`"${key}" must be a string or a number.`);
-        }
+    if (error?.message) {
+        return error.message;
     }
+    return String(error);
 }

package/package.json

@@ -1,47 +1,50 @@
 {
   "name": "@kash-88/alerts",
-  "version": "1.2.1",
-  "description": "A lightweight library for easy integration with the DonationAlerts API: authorization, token management, and user info in a few lines.",
+  "version": "1.3.0",
+  "description": "A library for seamless integration with the DonationAlerts API. It provides a comprehensive set of tools for authorization, user token management, retrieving account data, and handling various other API interactions.",
   "type": "module",
   "keywords": [
     "DonationAlerts",
     "DonationAlerts API",
-    "DonationAlerts SDK"
+    "DonationAlerts SDK",
+    "DonationAlerts WebSocket",
+    "DA API",
+    "DA SDK",
+    "DA WebSocket"
   ],
   "publishConfig": {
     "registry": "https://npm.pkg.github.com/",
     "access": "public"
   },
-  "homepage": "https://github.com/kash-88/alerts-SDK#readme",
+  "homepage": "https://github.com/kash-ts/alerts-SDK#readme",
   "bugs": {
-    "url": "https://github.com/kash-88/alerts-SDK/issues"
+    "url": "https://github.com/kash-ts/alerts-SDK/issues"
   },
   "main": "dist/src/index.js",
   "types": "dist/src/index.d.ts",
   "exports": {
     ".": {
-      "import": "./dist/src/index.js",
-      "require": "./dist/src/index.js"
+      "types": "./dist/src/index.d.ts",
+      "import": "./dist/src/index.js"
     }
   },
   "files": [
     "dist",
-    "src",
-    "ws"
+    "src"
   ],
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/kash-88/alerts-SDK.git"
+    "url": "git+https://github.com/kash-ts/alerts-SDK.git"
   },
-  "license": "ISC",
-  "author": "kash.88",
+  "license": "MIT",
+  "author": "kash-ts",
   "scripts": {
     "publish:github": "npm publish",
     "build": "tsc && tsc-alias",
     "prepublishOnly": "npm run build",
-    "publish:npm-laster": "npm publish --registry=https://registry.npmjs.org/ --tag latest",
-    "publish:npm-dev": "npm publish --registry=https://registry.npmjs.org/ --tag Dev",
-    "publish:npm-beta": "npm publish --registry=https://registry.npmjs.org/ --tag Beta"
+    "publish:npm-latest": "npm publish --@kash-88:registry=https://registry.npmjs.org/ --tag latest",
+    "publish:npm-dev": "npm publish --@kash-88:registry=https://registry.npmjs.org/ --tag dev",
+    "publish:npm-beta": "npm publish --@kash-88:registry=https://registry.npmjs.org/ --tag beta"
   },
   "dependencies": {
     "axios": "^1.10.0",
@@ -51,9 +54,10 @@
   "devDependencies": {
     "@types/node": "^20.12.12",
     "@types/ws": "^8.5.10",
+    "dotenv": "^16.4.5",
+    "readline-sync": "^1.4.10",
     "ts-node": "^10.9.2",
     "tsc-alias": "^1.8.16",
-    "tsconfig-paths": "^4.2.0",
-    "typescript": "^5.4.5"
+    "typescript": "^5.9.3"
   }
-}
+}