@kash-88/alerts 1.0.0

package/dist/src/func/updateAccessToken.js

@@ -0,0 +1,39 @@
+import axios from "axios";
+import { validateDataObject } from "../utils";
+/**
+ * Refreshes an access token using a refresh token.
+ *
+ * @example
+ * import { updateAccessToken } from "@kash.88/alerts";
+ *
+ * try {
+ *   const tokenData = await updateAccessToken({
+ *     client_id: "YOUR_CLIENT_ID",
+ *     client_secret: "YOUR_CLIENT_SECRET",
+ *     refresh_token: "USER_REFRESH_TOKEN"
+ *   });
+ *
+ *   console.log(tokenData.access_token);
+ * } catch (error) {
+ *   console.error("Error updating access token:", error.response.data);
+ * }
+ *
+ * @param {UpdateTokenData} data - The data for the token refresh request.
+ * @returns {Promise<OauthToken>} A promise that resolves to the new token data from the API.
+ * @see {@link https://www.donationalerts.com/apidoc#authorization__authorization_code__getting_access_token}
+ */
+export default async function updateAccessToken(data) {
+    try {
+        validateDataObject(data, ["client_id", "client_secret", "refresh_token"]);
+        const response = await axios.post("https://www.donationalerts.com/oauth/token", {
+            grant_type: "refresh_token",
+            client_id: data.client_id,
+            client_secret: data.client_secret,
+            refresh_token: data.refresh_token
+        });
+        return response.data;
+    }
+    catch (error) {
+        throw new Error(error?.response?.data?.error_description || error?.message || error);
+    }
+}

package/dist/src/index.d.ts

@@ -0,0 +1,9 @@
+import getAuthorizeLink from "./func/getAuthorizeLink";
+import getOauthToken from "./func/getOauthToken";
+import getUser from "./func/getUser";
+import updateAccessToken from "./func/updateAccessToken";
+import getUserChannel from "./func/getUserChannel";
+import { getPrivateToken } from "./func/getPrivateToken";
+import CentrifugeClient from "./ws/CentrifugeClient";
+export * from "./types";
+export { getAuthorizeLink, getOauthToken, getUser, updateAccessToken, getUserChannel, getPrivateToken, CentrifugeClient };

package/dist/src/index.js

@@ -0,0 +1,9 @@
+import getAuthorizeLink from "./func/getAuthorizeLink";
+import getOauthToken from "./func/getOauthToken";
+import getUser from "./func/getUser";
+import updateAccessToken from "./func/updateAccessToken";
+import getUserChannel from "./func/getUserChannel";
+import { getPrivateToken } from "./func/getPrivateToken";
+import CentrifugeClient from "./ws/CentrifugeClient";
+export * from "./types";
+export { getAuthorizeLink, getOauthToken, getUser, updateAccessToken, getUserChannel, getPrivateToken, CentrifugeClient };

package/dist/src/types.d.ts

@@ -0,0 +1,33 @@
+export interface OauthToken {
+    token_type: string;
+    expires_in: number;
+    access_token: string;
+    refresh_token: string;
+}
+export interface GetPrivateToken {
+    channel: string;
+    uuidv4_client_id: string;
+    access_token: string;
+}
+export interface User {
+    id: number;
+    code: string;
+    name: string;
+    avatar: string;
+    email: string;
+    socket_connection_token: string;
+}
+export interface GetAuthorizeLinkData {
+    client_id: string | number;
+    scope: string[];
+}
+export interface GetOauthData {
+    client_id: string | number;
+    client_secret: string;
+    code: string;
+}
+export interface UpdateTokenData {
+    client_id: string | number;
+    client_secret: string;
+    refresh_token: string;
+}

package/dist/src/types.js

@@ -0,0 +1 @@
+export {};

package/dist/src/utils.d.ts

@@ -0,0 +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
+ */
+/**
+ * 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[]>;
+/**
+ * Checks if required environment variables are present.
+ * Throws an error with a clear message if any variable is missing.
+ * @param {string[]} keys - List of required environment variable names.
+ */
+export declare function checkEnv(keys: string[]): void;

package/dist/src/utils.js

@@ -0,0 +1,48 @@
+/**
+ * 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
+ */
+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.");
+    }
+    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.`);
+        }
+    }
+}
+/**
+ * Checks if required environment variables are present.
+ * Throws an error with a clear message if any variable is missing.
+ * @param {string[]} keys - List of required environment variable names.
+ */
+export function checkEnv(keys) {
+    const missing = keys.filter((key) => !process.env[key]);
+    if (missing.length > 0) {
+        throw new Error(`Missing required environment variables: ${missing.join(", ")}`);
+    }
+}

package/dist/src/ws/CentrifugeClient.d.ts

@@ -0,0 +1,31 @@
+import { WebSocket } from "ws";
+import TypedEmitter from "typed-emitter";
+interface WSClientOptions {
+    channel: string;
+    socket_connection_token: string;
+    access_token: string;
+}
+interface CentrifugeMessage {
+    params: Record<string, unknown>;
+    id: number;
+    method?: number;
+}
+type MessageEvents = {
+    open: () => void;
+    message: (data: CentrifugeMessage) => void;
+    close: () => void;
+    error: (error: Error) => void;
+    reconnecting: (attempt: number) => void;
+    reconnect_failed: () => void;
+};
+declare const CentrifugeClient_base: new () => TypedEmitter<MessageEvents>;
+export default class CentrifugeClient extends CentrifugeClient_base {
+    private options;
+    private ws;
+    constructor(options: WSClientOptions);
+    createConnection(): WebSocket;
+    confirmConnection(socket_connection_token?: string): void;
+    connectPrivateToken(channel: string, uuidv4_client_id: string, access_token?: string): Promise<void>;
+    sendMessage(message: string): void;
+}
+export {};

package/dist/src/ws/CentrifugeClient.js

@@ -0,0 +1,71 @@
+import { getPrivateToken } from "../index";
+import { WebSocket } from "ws";
+import { EventEmitter } from "events";
+// --- Configuration ---
+const configuration = {
+    ws: {
+        url: "wss://centrifugo.donationalerts.com/connection/websocket"
+    }
+};
+// --- Class ---
+export default class CentrifugeClient extends EventEmitter {
+    constructor(options) {
+        super();
+        this.ws = null;
+        this.options = options;
+        this.ws;
+    }
+    createConnection() {
+        if (this.ws) {
+            return this.ws;
+        }
+        try {
+            this.ws = new WebSocket(configuration.ws.url);
+            return this.ws;
+        }
+        catch (error) {
+            console.error("[WS] Failed to create connection:", error);
+            throw error;
+        }
+    }
+    confirmConnection(socket_connection_token = this.options.socket_connection_token) {
+        const message = {
+            params: {
+                token: socket_connection_token
+            },
+            id: 1
+        };
+        this.sendMessage(JSON.stringify(message));
+    }
+    async connectPrivateToken(channel, uuidv4_client_id, access_token = this.options.access_token) {
+        try {
+            const token = await getPrivateToken({
+                channel,
+                uuidv4_client_id,
+                access_token
+            });
+            const subscribeMessage = {
+                params: {
+                    channel: channel,
+                    token
+                },
+                method: 1,
+                id: 2
+            };
+            this.sendMessage(JSON.stringify(subscribeMessage));
+        }
+        catch (error) {
+            throw new Error(error);
+        }
+    }
+    sendMessage(message) {
+        if (!this.ws)
+            return;
+        try {
+            this.ws.send(message);
+        }
+        catch (error) {
+            throw new Error(error);
+        }
+    }
+}

package/package.json

@@ -0,0 +1,59 @@
+{
+  "name": "@kash-88/alerts",
+  "version": "1.0.0",
+  "description": "DonationAlerts API for Node.js",
+  "type": "module",
+  "keywords": [
+    "DonationAlerts",
+    "DonationAlerts API",
+    "DonationAlerts SDK"
+  ],
+  "publishConfig": {
+    "registry": "https://npm.pkg.github.com/",
+    "access": "public"
+  },
+  "homepage": "https://github.com/kash-88/alerts-SDK#readme",
+  "bugs": {
+    "url": "https://github.com/kash-88/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"
+    }
+  },
+  "files": [
+    "dist",
+    "src",
+    "ws"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/kash-88/alerts-SDK.git"
+  },
+  "license": "ISC",
+  "author": "kash.88",
+  "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"
+  },
+  "dependencies": {
+    "axios": "^1.10.0",
+    "typed-emitter": "^2.1.0",
+    "ws": "^8.17.0"
+  },
+  "devDependencies": {
+    "@types/node": "^20.12.12",
+    "@types/ws": "^8.5.10",
+    "ts-node": "^10.9.2",
+    "tsc-alias": "^1.8.16",
+    "tsconfig-paths": "^4.2.0",
+    "typescript": "^5.4.5"
+  }
+}

package/readme.md

@@ -0,0 +1,82 @@
+# DonationAlerts API
+A convenient library for interacting with the DonationAlerts API! 
+
+## Installation
+```bash
+$ npm install @kash-88/alerts
+```
+
+## All methods
+
+## (Sync) getAuthorizeLink
+* Generates an authorization link for DonationAlerts OAuth.
+* Param: `{ client_id: string, scope: string[] }`
+* Api page: https://www.donationalerts.com/apidoc#authorization__authorization_code__authorization_request
+* Endpoint: https://www.donationalerts.com/oauth/authorize
+* Example:
+```js
+import { getAuthorizeLink } from '@kash-88/alerts';
+
+const link = getAuthorizeLink({
+  client_id: 'YOUR_CLIENT_ID',
+  scope: ['oauth-user-show'] // https://www.donationalerts.com/apidoc#authorization__scopes
+});
+
+console.log(link);
+```
+
+---
+
+## (Async) getOauthToken
+* Exchanges authorization code for access_token and refresh_token.
+* Param: `{ client_id: string, client_secret: string, code: string }`
+* Api page: https://www.donationalerts.com/apidoc#authorization__authorization_code__getting_access_token
+* Endpoint: https://www.donationalerts.com/oauth/token
+* Example:
+```js
+import { getOauthToken } from '@kash-88/alerts';
+
+const tokenData = await getOauthToken({
+  client_id: 'YOUR_CLIENT_ID',
+  client_secret: 'YOUR_CLIENT_SECRET',
+  code: 'AUTHORIZATION_CODE'
+});
+
+console.log(tokenData);
+```
+
+---
+
+## (Async) updateAccessToken
+* Refreshes access_token using refresh_token.
+* Param: `{ client_id: string|number, client_secret: string, refresh_token: string }`
+* Api page: https://www.donationalerts.com/apidoc#authorization__authorization_code__refreshing_access_tokens
+* Endpoint: https://www.donationalerts.com/oauth/token
+* Example:
+```js
+import { updateAccessToken } from '@kash-88/alerts';
+
+const tokenData = await updateAccessToken({
+  client_id: 'YOUR_CLIENT_ID',
+  client_secret: 'YOUR_CLIENT_SECRET',
+  refresh_token: 'USER_REFRESH_TOKEN'
+});
+
+console.log(tokenData.access_token);
+```
+
+---
+
+## (Async) getUser
+* Fetches user profile information by access_token.
+* Param: `access_token: string`
+* Api page: https://www.donationalerts.com/apidoc#api_v1__users
+* Endpoint: https://www.donationalerts.com/api/v1/user/oauth
+* Example:
+```js
+import { getUser } from '@kash-88/alerts';
+
+const user = await getUser('USER_ACCESS_TOKEN');
+
+console.log(user);
+```

package/src/example/getAuthorizeLink.ts

@@ -0,0 +1,15 @@
+import "dotenv/config";
+import { getAuthorizeLink } from "@kash-88/alerts";
+import { checkEnv } from "@utils";
+
+checkEnv(["CLIENT_ID", "SCOPE"]);
+
+const client_id = process.env.CLIENT_ID!;
+const scope = process.env.SCOPE ? process.env.SCOPE.split(",") : ["oauth-user-show"];
+
+try {
+    const link = getAuthorizeLink({ client_id, scope });
+    console.log("Authorize link:", link);
+} catch (error: any) {
+    console.error("Error:", error.message);
+} 

package/src/example/getOauthToken.ts

@@ -0,0 +1,18 @@
+import "dotenv/config";
+import { getOauthToken } from "@kash-88/alerts";
+import { checkEnv } from "@utils";
+
+checkEnv(["CLIENT_ID", "CLIENT_SECRET", "CODE"]);
+
+const client_id = process.env.CLIENT_ID!;
+const client_secret = process.env.CLIENT_SECRET!;
+const code = process.env.CODE!;
+
+(async () => {
+    try {
+        const token = await getOauthToken({ client_id, client_secret, code });
+        console.log("Oauth token:", token);
+    } catch (error: any) {
+        console.error("Error:", error.message);
+    }
+})(); 

package/src/example/getUser.ts

@@ -0,0 +1,16 @@
+import "dotenv/config";
+import { getUser } from "@kash-88/alerts";
+import { checkEnv } from "@utils";
+
+checkEnv(["ACCESS_TOKEN"]);
+
+const access_token = process.env.ACCESS_TOKEN!;
+
+(async () => {
+    try {
+        const user = await getUser(access_token);
+        console.log("User:", user);
+    } catch (error: any) {
+        console.error("Error:", error.message);
+    }
+})(); 

package/src/example/getUserChannel.ts

@@ -0,0 +1,14 @@
+import "dotenv/config";
+import { getUserChannel } from "@kash-88/alerts";
+import { checkEnv } from "@utils";
+
+checkEnv(["CLIENT_ID"]);
+
+const id = process.env.CLIENT_ID!;
+
+try {
+    const channel = getUserChannel(id);
+    console.log("User channel:", channel);
+} catch (error: any) {
+    console.error("Error:", error.message);
+} 

package/src/example/updateAccessToken.ts

@@ -0,0 +1,18 @@
+import "dotenv/config";
+import { updateAccessToken } from "@kash-88/alerts";
+import { checkEnv } from "@utils";
+
+checkEnv(["CLIENT_ID", "CLIENT_SECRET", "REFRESH_TOKEN"]);
+
+const client_id = process.env.CLIENT_ID!;
+const client_secret = process.env.CLIENT_SECRET!;
+const refresh_token = process.env.REFRESH_TOKEN!;
+
+(async () => {
+    try {
+        const token = await updateAccessToken({ client_id, client_secret, refresh_token });
+        console.log("Updated token:", token);
+    } catch (error: any) {
+        console.error("Error:", error.message);
+    }
+})(); 

package/src/example/wsExample.ts

@@ -0,0 +1,52 @@
+import "dotenv/config";
+
+import { getUser, getUserChannel, CentrifugeClient } from "@kash-88/alerts";
+import { checkEnv } from "@utils";
+
+checkEnv(["CLIENT_ID", "ACCESS_TOKEN", "SOCKET_CONNECTION_TOKEN"]);
+const access_token = process.env.ACCESS_TOKEN!;
+let isConnectToPrivate = false;
+
+async function main() {
+    try {
+        const user = await getUser(access_token);
+        const channel = getUserChannel(user.id);
+        const socket_connection_token = String(process.env.SOCKET_CONNECTION_TOKEN);
+
+        const client = new CentrifugeClient({
+            channel,
+            socket_connection_token,
+            access_token
+        });
+
+        const ws = client.createConnection();
+
+        ws.on("open", async () => {
+            console.log("WebSocket соединение открыто");
+            client.confirmConnection(socket_connection_token);
+        });
+
+        ws.on("message", (message) => {
+            const srt = message.toString("utf8");
+            const json = JSON.parse(srt);
+
+            if(json.id = 1 && !isConnectToPrivate) {
+                isConnectToPrivate = true; return client.connectPrivateToken(channel, json.result.client);
+            }
+
+            console.log(srt);
+        });
+
+        ws.on("close", () => {
+            console.log("WebSocket соединение закрыто");
+        });
+
+        ws.on("error", (err) => {
+            console.error("Ошибка WebSocket:", err);
+        });
+    } catch (error: any) {
+        console.error("Ошибка:", error.message);
+    }
+}
+
+main();

package/src/func/getAuthorizeLink.ts

@@ -0,0 +1,33 @@
+import { validateDataObject } from "@utils";
+import { GetAuthorizeLinkData } from "@type";
+
+/**
+ * Generates an authorization link for the DonationAlerts API.
+ * 
+ * @example
+ * import { getAuthorizeLink } from "@kash.88/alerts";
+ * 
+ * const authLink = getAuthorizeLink({
+ *   client_id: "YOUR_CLIENT_ID",
+ *   scope: ["oauth-user-show"]
+ * });
+ * console.log(authLink);
+ * 
+ * @param {GetAuthorizeLinkData} data - The data for generating the link.
+ * @returns {string} The authorization URL.
+ * @see {@link https://www.donationalerts.com/apidoc#authorization__authorization_code__authorization_request}
+ */
+
+export default function getAuthorizeLink(data: GetAuthorizeLinkData): string {
+    try {
+        validateDataObject(data, ["client_id", "scope"]);
+
+        if (!Array.isArray(data.scope)) {
+            throw new Error("You must provide \"scope\" as an array in the data object.");
+        }
+        
+        return `https://www.donationalerts.com/oauth/authorize?client_id=${data.client_id}&response_type=code&scope=${data.scope.join("%20")}`;
+    } catch (error: any) {
+        throw new Error(error?.response?.data?.error_description || error?.message || error);
+    }
+}

package/src/func/getOauthToken.ts

@@ -0,0 +1,46 @@
+import axios from "axios";
+import { validateDataObject } from "@utils";
+import { GetOauthData, OauthToken } from "@type";
+
+/**
+ * Exchanges an authorization code for an access token.
+ * 
+ * @example
+ * import { getOauthToken } from "@kash.88/alerts";
+ * 
+ * // The "code" is received after the user authorizes your application
+ * // via the link generated by "getAuthorizeLink".
+ * 
+ * try {
+ *   const tokenData = await getOauthToken({
+ *     client_id: "YOUR_CLIENT_ID",
+ *     client_secret: "YOUR_CLIENT_SECRET",
+ *     code: "AUTHORIZATION_CODE"
+ *   });
+ * 
+ *   console.log(tokenData.access_token);
+ * } catch (error) {
+ *   console.error("Error getting Oauth token:", error.response.data);
+ * }
+ * 
+ * @param {GetOauthData} data - The data for the token request.
+ * @returns {Promise<OauthToken>} A promise that resolves to the token data from the API.
+ * @see {@link https://www.donationalerts.com/apidoc#authorization__authorization_code__getting_access_token}
+ */
+
+export default async function getOauthToken(data: GetOauthData): Promise<OauthToken> {
+    try {
+        validateDataObject(data, ["client_id", "client_secret", "code"]);
+
+        const response = await axios.post<OauthToken>("https://www.donationalerts.com/oauth/token", {
+            grant_type: "authorization_code",
+            client_id: data.client_id,
+            client_secret: data.client_secret,
+            code: data.code
+        });
+
+        return response.data;
+    } catch (error: any) {
+        throw new Error(error?.response?.data?.error_description || error?.message || error);
+    }
+}