@kash-88/alerts 1.2.1 → 1.3.0

package/dist/src/Function/sendSaleAlert.js

@@ -0,0 +1,81 @@
+import axios from "axios";
+import generateSignature from "./generateSignature.js";
+import { formatAxiosError } from "../utils.js";
+/**
+ * Send a merchandise sale alert.
+ *
+ * @param {string} access_token - User access token
+ * @param {string} client_secret - API client secret key for signature
+ * @param {number} user_id - DonationAlerts user ID to which the sale is referenced
+ * @param {string} external_id - Up to 32 characters long unique sale ID
+ * @param {string} merchant_identifier - Merchant's ID on DonationAlerts
+ * @param {string} merchandise_identifier - Merchant's merchandise ID that was bought
+ * @param {number} amount - Grand total of the sale
+ * @param {string} currency - Currency code (EUR, USD, RUB, BRL, TRY)
+ * @param {number} [bought_amount=1] - Total number of bought items
+ * @param {string} [username] - Name of the customer
+ * @param {string} [message] - Message sent by the customer
+ *
+ * @returns {Promise<MerchandiseSale>} Created merchandise sale alert data
+ * @see {@link https://www.donationalerts.com/apidoc#api_v1__merchandise_sale_notifications__send_sale_alerts}
+ */
+export default async function sendSaleAlert(access_token, client_secret, user_id, external_id, merchant_identifier, merchandise_identifier, amount, currency, bought_amount = 1, username, message) {
+    if (!access_token || typeof access_token !== "string") {
+        throw new Error("access_token must be a non-empty string");
+    }
+    if (!client_secret || typeof client_secret !== "string") {
+        throw new Error("client_secret must be a non-empty string");
+    }
+    if (typeof user_id !== "number" || user_id <= 0) {
+        throw new Error("user_id must be a positive number");
+    }
+    if (!external_id || typeof external_id !== "string") {
+        throw new Error("external_id must be a non-empty string");
+    }
+    if (!merchant_identifier || typeof merchant_identifier !== "string") {
+        throw new Error("merchant_identifier must be a non-empty string");
+    }
+    if (!merchandise_identifier || typeof merchandise_identifier !== "string") {
+        throw new Error("merchandise_identifier must be a non-empty string");
+    }
+    if (typeof amount !== "number" || amount <= 0) {
+        throw new Error("amount must be a positive number");
+    }
+    if (!currency || typeof currency !== "string") {
+        throw new Error("currency must be a non-empty string");
+    }
+    if (typeof bought_amount !== "number" || bought_amount <= 0) {
+        throw new Error("bought_amount must be a positive number");
+    }
+    try {
+        const params = {
+            user_id,
+            external_id,
+            merchant_identifier,
+            merchandise_identifier,
+            amount,
+            currency,
+            bought_amount
+        };
+        if (username)
+            params.username = username;
+        if (message)
+            params.message = message;
+        const signature = generateSignature(params, client_secret);
+        params.signature = signature;
+        const formData = new URLSearchParams();
+        for (const [key, value] of Object.entries(params)) {
+            formData.append(key, String(value));
+        }
+        const response = await axios.post("https://www.donationalerts.com/api/v1/merchandise_sale", formData, {
+            headers: {
+                Authorization: `Bearer ${access_token}`,
+                "Content-Type": "application/x-www-form-urlencoded"
+            }
+        });
+        return response.data.data;
+    }
+    catch (error) {
+        throw new Error(formatAxiosError(error));
+    }
+}

package/dist/src/Function/updateMerchandise.d.ts

@@ -0,0 +1,21 @@
+import { Merchandise } from "../Types/index.js";
+/**
+ * Update an existing merchandise by its DonationAlerts ID.
+ *
+ * @param {string} access_token - User access token
+ * @param {string} client_secret - API client secret key for signature
+ * @param {number} merchandise_id - Unique merchandise ID on DonationAlerts
+ * @param {Record<string, string>} title - Object with merchandise titles in different locales (en_US required)
+ * @param {string} currency - Currency code (EUR, USD, RUB, BRL, TRY)
+ * @param {number} price_user - Revenue added to streamer for each sale
+ * @param {number} price_service - Revenue added to DonationAlerts for each sale
+ * @param {number} [is_active=0] - 0 or 1, whether merchandise is available for purchase
+ * @param {number} [is_percentage=0] - 0 or 1, whether prices are percentages or absolute amounts
+ * @param {string} [url] - URL to merchandise's web page
+ * @param {string} [img_url] - URL to merchandise's image
+ * @param {number} [end_at_ts] - Unix timestamp when merchandise becomes inactive
+ *
+ * @returns {Promise<Merchandise>} Updated merchandise data
+ * @see {@link https://www.donationalerts.com/apidoc#api_v1__merchandises__update_merchandise}
+ */
+export default function updateMerchandise(access_token: string, client_secret: string, merchandise_id: number, title: Record<string, string>, currency: string, price_user: number, price_service: number, is_active?: number, is_percentage?: number, url?: string, img_url?: string, end_at_ts?: number): Promise<Merchandise>;

package/dist/src/Function/updateMerchandise.js

@@ -0,0 +1,76 @@
+import axios from "axios";
+import generateSignature from "./generateSignature.js";
+import { formatAxiosError } from "../utils.js";
+/**
+ * Update an existing merchandise by its DonationAlerts ID.
+ *
+ * @param {string} access_token - User access token
+ * @param {string} client_secret - API client secret key for signature
+ * @param {number} merchandise_id - Unique merchandise ID on DonationAlerts
+ * @param {Record<string, string>} title - Object with merchandise titles in different locales (en_US required)
+ * @param {string} currency - Currency code (EUR, USD, RUB, BRL, TRY)
+ * @param {number} price_user - Revenue added to streamer for each sale
+ * @param {number} price_service - Revenue added to DonationAlerts for each sale
+ * @param {number} [is_active=0] - 0 or 1, whether merchandise is available for purchase
+ * @param {number} [is_percentage=0] - 0 or 1, whether prices are percentages or absolute amounts
+ * @param {string} [url] - URL to merchandise's web page
+ * @param {string} [img_url] - URL to merchandise's image
+ * @param {number} [end_at_ts] - Unix timestamp when merchandise becomes inactive
+ *
+ * @returns {Promise<Merchandise>} Updated merchandise data
+ * @see {@link https://www.donationalerts.com/apidoc#api_v1__merchandises__update_merchandise}
+ */
+export default async function updateMerchandise(access_token, client_secret, merchandise_id, title, currency, price_user, price_service, is_active = 0, is_percentage = 0, url, img_url, end_at_ts) {
+    if (!access_token || typeof access_token !== "string") {
+        throw new Error("access_token must be a non-empty string");
+    }
+    if (!client_secret || typeof client_secret !== "string") {
+        throw new Error("client_secret must be a non-empty string");
+    }
+    if (typeof merchandise_id !== "number" || merchandise_id <= 0) {
+        throw new Error("merchandise_id must be a positive number");
+    }
+    if (!title || Object.keys(title).length === 0) {
+        throw new Error("title must be a non-empty object");
+    }
+    if (!currency || typeof currency !== "string") {
+        throw new Error("currency must be a non-empty string");
+    }
+    if (typeof price_user !== "number" || typeof price_service !== "number") {
+        throw new Error("price_user and price_service must be numbers");
+    }
+    try {
+        const params = {
+            currency,
+            price_user,
+            price_service,
+            is_active,
+            is_percentage
+        };
+        for (const [locale, value] of Object.entries(title)) {
+            params[`title[${locale}]`] = value;
+        }
+        if (url)
+            params.url = url;
+        if (img_url)
+            params.img_url = img_url;
+        if (end_at_ts !== undefined)
+            params.end_at_ts = end_at_ts;
+        const signature = generateSignature(params, client_secret);
+        params.signature = signature;
+        const formData = new URLSearchParams();
+        for (const [key, value] of Object.entries(params)) {
+            formData.append(key, String(value));
+        }
+        const response = await axios.put(`https://www.donationalerts.com/api/v1/merchandise/${merchandise_id}`, formData, {
+            headers: {
+                Authorization: `Bearer ${access_token}`,
+                "Content-Type": "application/x-www-form-urlencoded"
+            }
+        });
+        return response.data.data;
+    }
+    catch (error) {
+        throw new Error(formatAxiosError(error));
+    }
+}

package/dist/src/Function/updateOauthToken.d.ts

@@ -0,0 +1,13 @@
+import { OAuthToken, OAuthScope } from "../Types/index.js";
+/**
+ * Refresh Access token using Refresh token.
+ *
+ * @param {string} client_id - Your client (application) ID
+ * @param {string} client_secret - Your client (application) secret
+ * @param {string} refresh_token - User refresh token
+ * @param {OAuthScope[]} scopes - Array of access scopes
+ *
+ * @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 updateOauthToken(client_id: string, client_secret: string, refresh_token: string, scopes: OAuthScope[]): Promise<OAuthToken>;

package/dist/src/Function/updateOauthToken.js

@@ -0,0 +1,44 @@
+import axios from "axios";
+import { formatAxiosError } from "../utils.js";
+/**
+ * Refresh Access token using Refresh token.
+ *
+ * @param {string} client_id - Your client (application) ID
+ * @param {string} client_secret - Your client (application) secret
+ * @param {string} refresh_token - User refresh token
+ * @param {OAuthScope[]} scopes - Array of access scopes
+ *
+ * @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 updateOauthToken(client_id, client_secret, refresh_token, scopes) {
+    if (!client_id || typeof client_id !== "string") {
+        throw new Error("client_id must be a non-empty string");
+    }
+    if (!client_secret || typeof client_secret !== "string") {
+        throw new Error("client_secret must be a non-empty string");
+    }
+    if (!refresh_token || typeof refresh_token !== "string") {
+        throw new Error("refresh_token must be a non-empty string");
+    }
+    if (!Array.isArray(scopes) || scopes.length === 0) {
+        throw new Error("scopes must be a non-empty array");
+    }
+    try {
+        const formData = new URLSearchParams();
+        formData.append("grant_type", "refresh_token");
+        formData.append("refresh_token", refresh_token);
+        formData.append("client_id", client_id);
+        formData.append("client_secret", client_secret);
+        formData.append("scope", Array.from(new Set(scopes)).join(" "));
+        const response = await axios.post("https://www.donationalerts.com/oauth/token", formData, {
+            headers: {
+                "Content-Type": "application/x-www-form-urlencoded"
+            }
+        });
+        return response.data;
+    }
+    catch (error) {
+        throw new Error(formatAxiosError(error));
+    }
+}

package/dist/src/Function/updateOrCreateMerchandise.d.ts

@@ -0,0 +1,22 @@
+import { Merchandise } from "../Types/index.js";
+/**
+ * Update or create a merchandise by merchant and merchandise identifiers.
+ *
+ * @param {string} access_token - User access token
+ * @param {string} client_secret - API client secret key for signature
+ * @param {string} merchant_identifier - Merchant's ID on DonationAlerts
+ * @param {string} merchandise_identifier - Up to 16 characters long unique merchandise ID
+ * @param {Record<string, string>} title - Object with merchandise titles in different locales (en_US required)
+ * @param {string} currency - Currency code (EUR, USD, RUB, BRL, TRY)
+ * @param {number} price_user - Revenue added to streamer for each sale
+ * @param {number} price_service - Revenue added to DonationAlerts for each sale
+ * @param {number} [is_active=0] - 0 or 1, whether merchandise is available for purchase
+ * @param {number} [is_percentage=0] - 0 or 1, whether prices are percentages or absolute amounts
+ * @param {string} [url] - URL to merchandise's web page
+ * @param {string} [img_url] - URL to merchandise's image
+ * @param {number} [end_at_ts] - Unix timestamp when merchandise becomes inactive
+ *
+ * @returns {Promise<Merchandise>} Updated or created merchandise data
+ * @see {@link https://www.donationalerts.com/apidoc#api_v1__merchandises__update_or_create_merchandise}
+ */
+export default function updateOrCreateMerchandise(access_token: string, client_secret: string, merchant_identifier: string, merchandise_identifier: string, title: Record<string, string>, currency: string, price_user: number, price_service: number, is_active?: number, is_percentage?: number, url?: string, img_url?: string, end_at_ts?: number): Promise<Merchandise>;

package/dist/src/Function/updateOrCreateMerchandise.js

@@ -0,0 +1,80 @@
+import axios from "axios";
+import generateSignature from "./generateSignature.js";
+import { formatAxiosError } from "../utils.js";
+/**
+ * Update or create a merchandise by merchant and merchandise identifiers.
+ *
+ * @param {string} access_token - User access token
+ * @param {string} client_secret - API client secret key for signature
+ * @param {string} merchant_identifier - Merchant's ID on DonationAlerts
+ * @param {string} merchandise_identifier - Up to 16 characters long unique merchandise ID
+ * @param {Record<string, string>} title - Object with merchandise titles in different locales (en_US required)
+ * @param {string} currency - Currency code (EUR, USD, RUB, BRL, TRY)
+ * @param {number} price_user - Revenue added to streamer for each sale
+ * @param {number} price_service - Revenue added to DonationAlerts for each sale
+ * @param {number} [is_active=0] - 0 or 1, whether merchandise is available for purchase
+ * @param {number} [is_percentage=0] - 0 or 1, whether prices are percentages or absolute amounts
+ * @param {string} [url] - URL to merchandise's web page
+ * @param {string} [img_url] - URL to merchandise's image
+ * @param {number} [end_at_ts] - Unix timestamp when merchandise becomes inactive
+ *
+ * @returns {Promise<Merchandise>} Updated or created merchandise data
+ * @see {@link https://www.donationalerts.com/apidoc#api_v1__merchandises__update_or_create_merchandise}
+ */
+export default async function updateOrCreateMerchandise(access_token, client_secret, merchant_identifier, merchandise_identifier, title, currency, price_user, price_service, is_active = 0, is_percentage = 0, url, img_url, end_at_ts) {
+    if (!access_token || typeof access_token !== "string") {
+        throw new Error("access_token must be a non-empty string");
+    }
+    if (!client_secret || typeof client_secret !== "string") {
+        throw new Error("client_secret must be a non-empty string");
+    }
+    if (!merchant_identifier || typeof merchant_identifier !== "string") {
+        throw new Error("merchant_identifier must be a non-empty string");
+    }
+    if (!merchandise_identifier || typeof merchandise_identifier !== "string") {
+        throw new Error("merchandise_identifier must be a non-empty string");
+    }
+    if (!title || Object.keys(title).length === 0) {
+        throw new Error("title must be a non-empty object");
+    }
+    if (!currency || typeof currency !== "string") {
+        throw new Error("currency must be a non-empty string");
+    }
+    if (typeof price_user !== "number" || typeof price_service !== "number") {
+        throw new Error("price_user and price_service must be numbers");
+    }
+    try {
+        const params = {
+            currency,
+            price_user,
+            price_service,
+            is_active,
+            is_percentage
+        };
+        for (const [locale, value] of Object.entries(title)) {
+            params[`title[${locale}]`] = value;
+        }
+        if (url)
+            params.url = url;
+        if (img_url)
+            params.img_url = img_url;
+        if (end_at_ts !== undefined)
+            params.end_at_ts = end_at_ts;
+        const signature = generateSignature(params, client_secret);
+        params.signature = signature;
+        const formData = new URLSearchParams();
+        for (const [key, value] of Object.entries(params)) {
+            formData.append(key, String(value));
+        }
+        const response = await axios.put(`https://www.donationalerts.com/api/v1/merchandise/${merchant_identifier}/${merchandise_identifier}`, formData, {
+            headers: {
+                Authorization: `Bearer ${access_token}`,
+                "Content-Type": "application/x-www-form-urlencoded"
+            }
+        });
+        return response.data.data;
+    }
+    catch (error) {
+        throw new Error(formatAxiosError(error));
+    }
+}

package/dist/src/Types/CustomAlerts.d.ts

@@ -0,0 +1,12 @@
+interface CustomAlerts {
+    id: number;
+    external_id: string | null;
+    header: string | null;
+    message: string | null;
+    image_url: string | null;
+    sound_url: string | null;
+    is_shown: 0 | 1;
+    created_at: string;
+    shown_at: string | null;
+}
+export default CustomAlerts;

package/dist/src/Types/DonationsAlerts.d.ts

@@ -0,0 +1,31 @@
+interface DonationsAlerts {
+    data: {
+        id: number;
+        name: string;
+        username: string;
+        message: string;
+        message_type: string;
+        amount: number;
+        currency: string;
+        is_shown: number;
+        created_at: string;
+        shown_at: string | null;
+        amount_in_user_currency?: number;
+    }[];
+    links: {
+        first: string;
+        last: string;
+        prev: string | null;
+        next: string | null;
+    };
+    meta: {
+        current_page: number;
+        from: number;
+        last_page: number;
+        path: string;
+        per_page: number;
+        to: number;
+        total: number;
+    };
+}
+export default DonationsAlerts;

package/dist/src/Types/DonationsAlerts.js

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

package/dist/src/Types/Merchandise.d.ts

@@ -0,0 +1,18 @@
+interface Merchandise {
+    id: number;
+    merchant: {
+        identifier: string;
+        name: string;
+    };
+    identifier: string;
+    title: Record<string, string>;
+    is_active: 0 | 1;
+    is_percentage: 0 | 1;
+    currency: string;
+    price_user: number;
+    price_service: number;
+    url: string | null;
+    img_url: string | null;
+    end_at: string | null;
+}
+export default Merchandise;

package/dist/src/Types/Merchandise.js

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

package/dist/src/Types/MerchandiseSale.d.ts

@@ -0,0 +1,14 @@
+interface MerchandiseSale {
+    id: number;
+    name: string;
+    external_id: string;
+    username: string | null;
+    message: string | null;
+    amount: number;
+    currency: string;
+    bought_amount: number;
+    is_shown: number;
+    created_at: string;
+    shown_at: string | null;
+}
+export default MerchandiseSale;

package/dist/src/Types/MerchandiseSale.js

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

package/dist/src/Types/OAuthScope.d.ts

@@ -0,0 +1,9 @@
+declare enum OAuthScope {
+    UserShow = "oauth-user-show",
+    DonationSubscribe = "oauth-donation-subscribe",
+    DonationIndex = "oauth-donation-index",
+    CustomAlertStore = "oauth-custom_alert-store",
+    GoalSubscribe = "oauth-goal-subscribe",
+    PollSubscribe = "oauth-poll-subscribe"
+}
+export default OAuthScope;

package/dist/src/Types/OAuthScope.js

@@ -0,0 +1,10 @@
+var OAuthScope;
+(function (OAuthScope) {
+    OAuthScope["UserShow"] = "oauth-user-show";
+    OAuthScope["DonationSubscribe"] = "oauth-donation-subscribe";
+    OAuthScope["DonationIndex"] = "oauth-donation-index";
+    OAuthScope["CustomAlertStore"] = "oauth-custom_alert-store";
+    OAuthScope["GoalSubscribe"] = "oauth-goal-subscribe";
+    OAuthScope["PollSubscribe"] = "oauth-poll-subscribe";
+})(OAuthScope || (OAuthScope = {}));
+export default OAuthScope;

package/dist/src/Types/OAuthToken.d.ts

@@ -0,0 +1,7 @@
+interface OAuthToken {
+    token_type: string;
+    expires_in: number;
+    access_token: string;
+    refresh_token?: string;
+}
+export default OAuthToken;

package/dist/src/Types/OAuthToken.js

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

package/dist/src/Types/User.d.ts

@@ -0,0 +1,9 @@
+interface User {
+    id: number;
+    code: string;
+    name: string;
+    avatar: string;
+    email: string;
+    socket_connection_token: string;
+}
+export default User;

package/dist/src/Types/User.js

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

package/dist/src/Types/index.d.ts

@@ -0,0 +1,8 @@
+import CustomAlerts from "./CustomAlerts.js";
+import DonationsAlerts from "./DonationsAlerts.js";
+import Merchandise from "./Merchandise.js";
+import MerchandiseSale from "./MerchandiseSale.js";
+import OAuthScope from "./OAuthScope.js";
+import OAuthToken from "./OAuthToken.js";
+import User from "./User.js";
+export { CustomAlerts, DonationsAlerts, Merchandise, MerchandiseSale, OAuthScope, OAuthToken, User };

package/dist/src/Types/index.js

@@ -0,0 +1,2 @@
+import OAuthScope from "./OAuthScope.js";
+export { OAuthScope };

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

@@ -0,0 +1,71 @@
+import TypedEmitter from "typed-emitter";
+interface WSClientOptions {
+    access_token: string;
+    channels?: string[];
+    autoReconnect?: boolean;
+}
+type MessageEvents = {
+    open: () => void;
+    message: (data: any) => void;
+    close: (code: number, reason: Buffer) => void;
+    error: (error: Error) => void;
+    reconnect: () => void;
+};
+declare const CentrifugeClient_base: new () => TypedEmitter<MessageEvents>;
+/**
+ * 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 CentrifugeClient_base {
+    private WebSocket;
+    private user;
+    private userPromise;
+    private access_token;
+    private channels;
+    private autoReconnect;
+    private isAuthorized;
+    private reconnectTimer;
+    private isReconnecting;
+    private authMessageHandler;
+    constructor(options: WSClientOptions);
+    /**
+     * Obtain user data
+     *
+     * @param {string} access_token - User access token
+     * @returns {Promise<User>} User data
+     */
+    private getUser;
+    /**
+     * Get channels to subscribe to
+     *
+     * @returns {Promise<string[]>} Array of channel identifiers
+     */
+    private getChannels;
+    /**
+     * Create a new WebSocket connection
+     */
+    createNewConnection(): void;
+    /**
+     * Forward events through a TypedEmitter
+     */
+    private setupEvent;
+    /**
+     * Authorize WebSocket and subscribe to selected channels
+     */
+    authorization(): Promise<void>;
+    /**
+     * Send a message through the WebSocket connection
+     *
+     * @param {string} message - JSON-encoded message to send
+     */
+    sendMessage(message: string): void;
+    /**
+     * Close the WebSocket connection and stop auto-reconnect
+     */
+    close(): void;
+}
+export {};