@kash-88/alerts 1.1.0 → 1.2.0

package/package.json

@@ -1,59 +1,59 @@
-{
-  "name": "@kash-88/alerts",
-  "version": "1.1.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"
-  }
-}
+{
+  "name": "@kash-88/alerts",
+  "version": "1.2.0",
+  "description": "A lightweight library for easy integration with the DonationAlerts API: authorization, token management, and user info in a few lines.",
+  "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

@@ -1,82 +1,212 @@
+<div align="center">
+
 # DonationAlerts API
-A convenient library for interacting with the DonationAlerts API! 
+A lightweight library for easy integration with the DonationAlerts API: authorization, token management, and user info in a few lines.
+
+[![npm version](https://img.shields.io/npm/v/@kash-88/alerts.svg?style=flat-square)](https://www.npmjs.com/package/@kash-88/alerts/v/latest)
+[![npm downloads](https://img.shields.io/npm/dm/@kash-88/alerts.svg?style=flat-square)](https://www.npmjs.com/package/@kash-88/alerts/v/latests)
+[![install size](https://img.shields.io/badge/dynamic/json?url=https://packagephobia.com/v2/api.json?p=@kash-88/alerts&query=$.install.pretty&label=install%20size&style=flat-square)](https://www.npmjs.com/package/@kash-88/alerts/v/latest)
+
+</div>
+
+Available in: [RU](https://github.com/kash-88/alerts-SDC/readme-ru.md), **EN**
 
 ## Installation
+Using npm:
+
 ```bash
 $ npm install @kash-88/alerts
 ```
 
-## All methods
+Using yarn:
+
+```bash
+$ yarn add @kash-88/alerts
+```
+
+Using pnpm:
+
+```bash
+$ pnpm add @kash-88/alerts
+```
+
+Using bun:
+
+```bash
+$ bun add @kash-88/alerts
+```
+
+## Available Methods (Quick Overview)
+| Function            | Purpose                                                      |
+|---------------------|--------------------------------------------------------------|
+| getAuthorizeLink    | Generate OAuth authorization link                            |
+| getOauthToken       | Exchange code for access_token and refresh_token             |
+| getUser             | Fetch user profile by access_token                           |
+| getUserChannel      | Get user channel by user_id                                  |
+| updateAccessToken   | Refresh access_token using refresh_token                     |
+| getPrivateToken     | Get private token for channel subscription                   |
+
+---
 
-## (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:
+## getAuthorizeLink (Sync)
+**Purpose:** Generate OAuth authorization link for DonationAlerts.
+
+- **Params:**
+  - `client_id: string` — Your app"s client ID
+  - `scope: string[]` — Array of access scopes
+- **Endpoint:** https://www.donationalerts.com/oauth/authorize
+- **API Docs:** [Authorization Request](https://www.donationalerts.com/apidoc#authorization__authorization_code__authorization_request)
+
+**Example:**
 ```js
-import { getAuthorizeLink } from '@kash-88/alerts';
+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
-});
+const client_id = "YOUR_CLIENT_ID"; // Get on https://www.donationalerts.com/application/clients
+const scope = ["oauth-user-show"];
 
-console.log(link);
+try {
+    const link = getAuthorizeLink({ client_id, scope });
+    console.log("Authorize link:", link);
+} catch (error) {
+    console.error("Error:", error.message);
+} 
 ```
 
 ---
 
-## (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:
+## getOauthToken (Async)
+**Purpose:** Exchange authorization code for access_token and refresh_token.
+
+- **Params:**
+  - `client_id: string` — Your app's client ID
+  - `client_secret: string` — Your app's client secret
+  - `code: string` — Authorization code
+- **Endpoint:** https://www.donationalerts.com/oauth/token
+- **API Docs:** [Getting Access Token](https://www.donationalerts.com/apidoc#authorization__authorization_code__getting_access_token)
+
+**Example:**
 ```js
-import { getOauthToken } from '@kash-88/alerts';
+import { getOauthToken } from "@kash-88/alerts";
+
+// Get on https://www.donationalerts.com/application/clients
+const client_id = "YOUR_CLIENT_ID";
+const client_secret = process.env.CLIENT_SECRET!;
+const code = "USER_CODE";
+
+(async () => {
+    try {
+        const token = await getOauthToken({ client_id, client_secret, code });
+        console.log("Oauth token:", token);
+    } catch (error) {
+        console.error("Error:", error.message);
+    }
+})(); 
+```
 
-const tokenData = await getOauthToken({
-  client_id: 'YOUR_CLIENT_ID',
-  client_secret: 'YOUR_CLIENT_SECRET',
-  code: 'AUTHORIZATION_CODE'
-});
+---
+
+## getUser (Async)
+**Purpose:** Fetch user profile information by access_token.
 
-console.log(tokenData);
+- **Params:**
+  - `access_token: string` — User's access token
+- **Endpoint:** https://www.donationalerts.com/api/v1/user/oauth
+- **API Docs:** [User Info](https://www.donationalerts.com/apidoc#api_v1__users)
+
+**Example:**
+```js
+import { getUser } from "@kash-88/alerts";
+
+const user_access_token = "USER_ACCESS_TOKEN";
+
+(async () => {
+    try {
+        const user = await getUser(user_access_token);
+        console.log("User data:", user);
+    } catch (error) {
+        console.error("Error:", error.message);
+    }
+})(); 
 ```
 
 ---
 
-## (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:
+## getUserChannel (Sync)
+**Purpose:** Get user channel by user_id.
+
+- **Params:**
+  - `user_id: string` — User ID
+- **Endpoint:** —
+- **API Docs:** —
+
+**Example:**
 ```js
-import { updateAccessToken } from '@kash-88/alerts';
+import { getUserChannel } from "@kash-88/alerts";
 
-const tokenData = await updateAccessToken({
-  client_id: 'YOUR_CLIENT_ID',
-  client_secret: 'YOUR_CLIENT_SECRET',
-  refresh_token: 'USER_REFRESH_TOKEN'
-});
+const user_id = "USER_ID";
 
-console.log(tokenData.access_token);
+const channel = getUserChannel(user_id);
+console.log("User channel:", channel);
 ```
 
 ---
 
-## (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:
+## updateAccessToken (Async)
+**Purpose:** Refresh access_token using refresh_token.
+
+- **Params:**
+  - `client_id: string` — Your app's client ID
+  - `client_secret: string` — Your app's client secret
+  - `refresh_token: string` — Refresh token
+- **Endpoint:** https://www.donationalerts.com/oauth/token
+- **API Docs:** [Refreshing Access Tokens](https://www.donationalerts.com/apidoc#authorization__authorization_code__refreshing_access_tokens)
+
+**Example:**
 ```js
-import { getUser } from '@kash-88/alerts';
+import "dotenv/config";
+import { getOauthToken } from "@kash-88/alerts";
+
+// Get on https://www.donationalerts.com/application/clients
+const client_id = "YOUR_CLIENT_ID";
+const client_secret = process.env.CLIENT_SECRET!;
+
+const refresh_token = "USER_REFRESH_TOKEN";
+
+(async () => {
+    try {
+        const token = await getOauthToken({ client_id, client_secret, refresh_token });
+        console.log("Oauth token:", token);
+    } catch (error) {
+        console.error("Error:", error.message);
+    }
+})();
+```
 
-const user = await getUser('USER_ACCESS_TOKEN');
+---
+
+## getPrivateToken (Async)
+**Purpose:** Get a private token for subscribing to a DonationAlerts channel via Centrifuge.
 
-console.log(user);
-```
+- **Params:**
+  - `channel: string` — Channel name to subscribe
+  - `uuidv4_client_id: string` — UUID v4 client ID (used in WebSocket connection)
+  - `access_token: string` — User's OAuth access token
+- **Endpoint:** https://www.donationalerts.com/api/v1/centrifuge/subscribe
+- **API Docs:** —
+
+**Example:**
+```js
+import { getPrivateToken } from "@kash-88/alerts";
+
+const channel = "USER_CHANNEL"; // Get via getUserChannel
+const uuidv4_client_id = "UUIDv4_CLIENT_ID"; // WebSocket client UUID
+const access_token = "USER_ACCESS_TOKEN";
+
+(async () => {
+    try {
+        const token = await getPrivateToken({ channel, uuidv4_client_id, access_token });
+        console.log("Private token:", token);
+    } catch (error) {
+        console.error("Error getting private token:", error.message);
+    }
+})();

package/src/example/getAuthorizeLink.ts

@@ -1,8 +1,7 @@
-import "dotenv/config";
 import { getAuthorizeLink } from "@kash-88/alerts";
 
-const client_id = process.env.CLIENT_ID!;
-const scope = process.env.SCOPE ? process.env.SCOPE.split(",") : ["oauth-user-show"];
+const client_id = "YOUR_CLIENT_ID"; // Get on https://www.donationalerts.com/application/clients
+const scope = ["oauth-user-show", "oauth-donation-subscribe", "oauth-donation-index", "oauth-custom_alert-store", "oauth-goal-subscribe", "oauth-poll-subscribe"];
 
 try {
     const link = getAuthorizeLink({ client_id, scope });

package/src/example/getOauthToken.ts

@@ -1,9 +1,10 @@
 import "dotenv/config";
 import { getOauthToken } from "@kash-88/alerts";
 
-const client_id = process.env.CLIENT_ID!;
+// Get on https://www.donationalerts.com/application/clients
+const client_id = "YOUR_CLIENT_ID";
 const client_secret = process.env.CLIENT_SECRET!;
-const code = process.env.CODE!;
+const code = "CLIENT_CODE";
 
 (async () => {
     try {

package/src/example/getUser.ts

@@ -1,7 +1,6 @@
-import "dotenv/config";
 import { getUser } from "@kash-88/alerts";
 
-const access_token = process.env.ACCESS_TOKEN!;
+const access_token = 'USER_ACCESS_TOKEN';
 
 (async () => {
     try {

package/src/example/getUserChannel.ts

@@ -1,10 +1,9 @@
-import "dotenv/config";
 import { getUserChannel } from "@kash-88/alerts";
 
-const id = process.env.CLIENT_ID!;
+const user_id = "USER_ID";
 
 try {
-    const channel = getUserChannel(id);
+    const channel = getUserChannel(user_id);
     console.log("User channel:", channel);
 } catch (error: any) {
     console.error("Error:", error.message);

package/src/example/updateAccessToken.ts

@@ -1,9 +1,11 @@
 import "dotenv/config";
 import { updateAccessToken } from "@kash-88/alerts";
 
-const client_id = process.env.CLIENT_ID!;
+// Get on https://www.donationalerts.com/application/clients
+const client_id = "YOUR_CLIENT_ID";
 const client_secret = process.env.CLIENT_SECRET!;
-const refresh_token = process.env.REFRESH_TOKEN!;
+
+const refresh_token = "USER_REFRESH_TOKEN";
 
 (async () => {
     try {

package/dist/src/example/getAuthorizeLink.d.ts

@@ -1 +0,0 @@
-import "dotenv/config";

package/dist/src/example/getAuthorizeLink.js

@@ -1,11 +0,0 @@
-import "dotenv/config";
-import { getAuthorizeLink } from "../index.js";
-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) {
-    console.error("Error:", error.message);
-}

package/dist/src/example/getOauthToken.d.ts

@@ -1 +0,0 @@
-import "dotenv/config";

package/dist/src/example/getOauthToken.js

@@ -1,14 +0,0 @@
-import "dotenv/config";
-import { getOauthToken } from "../index.js";
-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) {
-        console.error("Error:", error.message);
-    }
-})();

package/dist/src/example/getUser.d.ts

@@ -1 +0,0 @@
-import "dotenv/config";

package/dist/src/example/getUser.js

@@ -1,12 +0,0 @@
-import "dotenv/config";
-import { getUser } from "../index.js";
-const access_token = process.env.ACCESS_TOKEN;
-(async () => {
-    try {
-        const user = await getUser(access_token);
-        console.log("User:", user);
-    }
-    catch (error) {
-        console.error("Error:", error.message);
-    }
-})();

package/dist/src/example/getUserChannel.d.ts

@@ -1 +0,0 @@
-import "dotenv/config";

package/dist/src/example/getUserChannel.js

@@ -1,10 +0,0 @@
-import "dotenv/config";
-import { getUserChannel } from "../index.js";
-const id = process.env.CLIENT_ID;
-try {
-    const channel = getUserChannel(id);
-    console.log("User channel:", channel);
-}
-catch (error) {
-    console.error("Error:", error.message);
-}

package/dist/src/example/updateAccessToken.d.ts

@@ -1 +0,0 @@
-import "dotenv/config";

package/dist/src/example/updateAccessToken.js

@@ -1,14 +0,0 @@
-import "dotenv/config";
-import { updateAccessToken } from "../index.js";
-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) {
-        console.error("Error:", error.message);
-    }
-})();

package/dist/src/example/wsExample.d.ts

@@ -1 +0,0 @@
-import "dotenv/config";

package/dist/src/example/wsExample.js

@@ -1,40 +0,0 @@
-import "dotenv/config";
-import { getUser, getUserChannel, CentrifugeClient } from "../index.js";
-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) {
-        console.error("Ошибка:", error.message);
-    }
-}
-main();