@kash-88/alerts 1.0.0

package/dist/example/getAuthorizeLink.d.ts

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

package/dist/example/getAuthorizeLink.js

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

package/dist/example/getOauthToken.d.ts

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

package/dist/example/getOauthToken.js

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

package/dist/example/getUser.d.ts

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

package/dist/example/getUser.js

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

package/dist/example/getUserChannel.d.ts

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

package/dist/example/getUserChannel.js

@@ -0,0 +1,12 @@
+import 'dotenv/config';
+import { getUserChannel } from '../src/index';
+import { checkEnv } from '../src/utils';
+checkEnv(['CLIENT_ID']);
+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/example/updateAccessToken.d.ts

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

package/dist/example/updateAccessToken.js

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

package/dist/example/wsExample.d.ts

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

package/dist/example/wsExample.js

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

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

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

package/dist/src/example/getAuthorizeLink.js

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

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

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

package/dist/src/example/getOauthToken.js

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

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

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

package/dist/src/example/getUser.js

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

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

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

package/dist/src/example/getUserChannel.js

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

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

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

package/dist/src/example/updateAccessToken.js

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

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

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

package/dist/src/example/wsExample.js

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

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

@@ -0,0 +1,18 @@
+import { GetAuthorizeLinkData } from "../types";
+/**
+ * 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;

package/dist/src/func/getAuthorizeLink.js

@@ -0,0 +1,29 @@
+import { validateDataObject } from "../utils";
+/**
+ * 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) {
+    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) {
+        throw new Error(error?.response?.data?.error_description || error?.message || error);
+    }
+}

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

@@ -0,0 +1,27 @@
+import { GetOauthData, OauthToken } from "../types";
+/**
+ * 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 function getOauthToken(data: GetOauthData): Promise<OauthToken>;

package/dist/src/func/getOauthToken.js

@@ -0,0 +1,42 @@
+import axios from "axios";
+import { validateDataObject } from "../utils";
+/**
+ * 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) {
+    try {
+        validateDataObject(data, ["client_id", "client_secret", "code"]);
+        const response = await axios.post("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) {
+        throw new Error(error?.response?.data?.error_description || error?.message || error);
+    }
+}

package/dist/src/func/getPrivateToken.d.ts

@@ -0,0 +1,29 @@
+import { GetPrivateToken } from "../types";
+/**
+ * Gets a private token for subscribing to a DonationAlerts channel via Centrifuge.
+ *
+ * @example
+ * import { connectPrivateToken } from "../index";
+ *
+ * // The "channel" can be obtained using the "getUserChannel" function,
+ * // and the "uuidv4_client_id" is provided during authentication in WebSocket (ws).
+ *
+ * try {
+ *   const token = await connectPrivateToken({
+ *     channel: "USER_CHANNEL",
+ *     uuidv4_client_id: "USER_uuid_ID",
+ *     access_token: "USER_ACCESS_TOKEN"
+ *   });
+ *
+ *   console.log(token);
+ * } catch (error) {
+ *   console.error("Error getting Oauth token:", error.response.data);
+ * }
+ *
+ * @param {Object} params - Parameters for getting the token.
+ * @param {string} params.channel - Channel name to subscribe.
+ * @param {string} params.uuidv4_client_id - UUID v4 client ID.
+ * @param {string} params.access_token - OAuth access token of the user.
+ * @returns {Promise<string>} - Token for channel subscription.
+ */
+export declare function getPrivateToken(data: GetPrivateToken): Promise<string>;

package/dist/src/func/getPrivateToken.js

@@ -0,0 +1,46 @@
+import axios from "axios";
+import { validateDataObject } from "../utils";
+/**
+ * Gets a private token for subscribing to a DonationAlerts channel via Centrifuge.
+ *
+ * @example
+ * import { connectPrivateToken } from "../index";
+ *
+ * // The "channel" can be obtained using the "getUserChannel" function,
+ * // and the "uuidv4_client_id" is provided during authentication in WebSocket (ws).
+ *
+ * try {
+ *   const token = await connectPrivateToken({
+ *     channel: "USER_CHANNEL",
+ *     uuidv4_client_id: "USER_uuid_ID",
+ *     access_token: "USER_ACCESS_TOKEN"
+ *   });
+ *
+ *   console.log(token);
+ * } catch (error) {
+ *   console.error("Error getting Oauth token:", error.response.data);
+ * }
+ *
+ * @param {Object} params - Parameters for getting the token.
+ * @param {string} params.channel - Channel name to subscribe.
+ * @param {string} params.uuidv4_client_id - UUID v4 client ID.
+ * @param {string} params.access_token - OAuth access token of the user.
+ * @returns {Promise<string>} - Token for channel subscription.
+ */
+export async function getPrivateToken(data) {
+    try {
+        validateDataObject(data, ["channel", "uuidv4_client_id", "access_token"]);
+        const response = await axios.post("https://www.donationalerts.com/api/v1/centrifuge/subscribe", {
+            channels: [data.channel],
+            client: data.uuidv4_client_id
+        }, {
+            headers: {
+                "Authorization": `Bearer ${data.access_token}`
+            }
+        });
+        return response.data.channels[0].token;
+    }
+    catch (error) {
+        throw new Error(error?.response?.data?.error_description || error?.message || error);
+    }
+}

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

@@ -0,0 +1,23 @@
+import { User } from "../types";
+/**
+ * Fetches the profile information for the authenticated user.
+ *
+ * @example
+ * import { getUser } from "@kash.88/alerts";
+ *
+ * // Get an access_token using getOauthToken or updateAccessToken
+ *
+ * try {
+ *   const accessToken = "USER_ACCESS_TOKEN";
+ *   const user = await getUser(accessToken);
+ *
+ *   console.log(user);
+ * } catch (error) {
+ *   console.error("Error fetching user:", error.response.data);
+ * }
+ *
+ * @param {string} access_token - The access token for authentication.
+ * @returns {Promise<User>} A promise that resolves to the user profile data.
+ * @see {@link https://www.donationalerts.com/apidoc#api_v1__users__user_profile_information}
+ */
+export default function getUser(access_token: string): Promise<User>;

package/dist/src/func/getUser.js

@@ -0,0 +1,38 @@
+import axios from "axios";
+/**
+ * Fetches the profile information for the authenticated user.
+ *
+ * @example
+ * import { getUser } from "@kash.88/alerts";
+ *
+ * // Get an access_token using getOauthToken or updateAccessToken
+ *
+ * try {
+ *   const accessToken = "USER_ACCESS_TOKEN";
+ *   const user = await getUser(accessToken);
+ *
+ *   console.log(user);
+ * } catch (error) {
+ *   console.error("Error fetching user:", error.response.data);
+ * }
+ *
+ * @param {string} access_token - The access token for authentication.
+ * @returns {Promise<User>} A promise that resolves to the user profile data.
+ * @see {@link https://www.donationalerts.com/apidoc#api_v1__users__user_profile_information}
+ */
+export default async function getUser(access_token) {
+    try {
+        if (!access_token) {
+            throw new Error("You must provide \"access_token\" as a non-empty string.");
+        }
+        const response = await axios.get("https://www.donationalerts.com/api/v1/user/oauth", {
+            headers: {
+                Authorization: `Bearer ${access_token}`
+            }
+        });
+        return response.data.data;
+    }
+    catch (error) {
+        throw new Error(error?.response?.data?.error_description || error?.message || error);
+    }
+}

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

@@ -0,0 +1,19 @@
+/**
+ * Fetches the profile information for the authenticated user.
+ *
+ * @example
+ * import { getUserChannel } from "@kash.88/alerts";
+ *
+ * // The "id" can be obtained using the "getUser" function,
+ *
+ * try {
+ *   const userId = "USER_ID";
+ *   const channelId = getUserChannel(userId);
+ * } catch (error) {
+ *   console.error("Error generating channel ID:", error.message);
+ * }
+ *
+ * @param {string|number} id - The user ID for which to generate the channel identifier.
+ * @returns {string} The donation alert channel identifier in the format "$alerts:donation_{id}".
+ */
+export default function getUserChannel(id: string | number): string;

package/dist/src/func/getUserChannel.js

@@ -0,0 +1,32 @@
+/**
+ * Fetches the profile information for the authenticated user.
+ *
+ * @example
+ * import { getUserChannel } from "@kash.88/alerts";
+ *
+ * // The "id" can be obtained using the "getUser" function,
+ *
+ * try {
+ *   const userId = "USER_ID";
+ *   const channelId = getUserChannel(userId);
+ * } catch (error) {
+ *   console.error("Error generating channel ID:", error.message);
+ * }
+ *
+ * @param {string|number} id - The user ID for which to generate the channel identifier.
+ * @returns {string} The donation alert channel identifier in the format "$alerts:donation_{id}".
+ */
+export default function getUserChannel(id) {
+    try {
+        if (typeof id !== "string" && typeof id !== "number") {
+            throw new Error("You must provide \"id\" as a string or number.");
+        }
+        if (id === null || id === undefined || id === "") {
+            throw new Error("You must provide a non-empty \"id\".");
+        }
+        return `$alerts:donation_${id}`;
+    }
+    catch (error) {
+        throw new Error(error?.response?.data?.error_description || error?.message || error);
+    }
+}

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

@@ -0,0 +1,24 @@
+import { UpdateTokenData, OauthToken } from "../types";
+/**
+ * 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 function updateAccessToken(data: UpdateTokenData): Promise<OauthToken>;