@kash-88/alerts 1.2.1 → 1.3.0

package/src/index.ts

@@ -1,19 +1,38 @@
 import getAuthorizeLink from "@function/getAuthorizeLink.js";
 import getOauthToken from "@function/getOauthToken.js";
 import getUser from "@function/getUser.js";
-import updateAccessToken from "@function/updateAccessToken.js";
+import updateOauthToken from "@function/updateOauthToken.js";
 import getUserChannel from "@function/getUserChannel.js";
-import { getPrivateToken } from "@function/getPrivateToken.js";
-import CentrifugeClient from "@ws/CentrifugeClient.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";
 
-export * from "@type";
+import WebServer from "@ws/CentrifugeClient.js";
+import { OAuthScope } from "@type";
 
 export {
     getAuthorizeLink,
     getOauthToken,
     getUser,
-    updateAccessToken,
+    updateOauthToken,
     getUserChannel,
+    getExternal,
     getPrivateToken,
-    CentrifugeClient
+    getDonationsAlerts,
+    createCustomAlerts,
+    generateSignature,
+    createMerchandise,
+    updateMerchandise,
+    updateOrCreateMerchandise,
+    getUserDataFromPromocode,
+    sendSaleAlert,
+    WebServer,
+    OAuthScope
 }; 

package/src/utils.ts

@@ -1,44 +1,22 @@
-/**
- * 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: unknown): value is Record<string, unknown> {
-    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: unknown, requiredKeys: string[]): asserts data is Record<string, string | number | string[]> {
-    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.`);
-        }
-    }
-}
+/**
+ * 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
+ */
+
+export function formatAxiosError(error: any): string {
+    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;
+    }
+    if (error?.message) {
+        return error.message;
+    }
+    return String(error);
+}

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

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

@@ -1,29 +0,0 @@
-import { validateDataObject } from "../utils.js";
-/**
- * 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

@@ -1,27 +0,0 @@
-import { GetOauthData, OauthToken } from "../types.js";
-/**
- * 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

@@ -1,42 +0,0 @@
-import axios from "axios";
-import { validateDataObject } from "../utils.js";
-/**
- * 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

@@ -1,29 +0,0 @@
-import { GetPrivateToken } from "../types.js";
-/**
- * Gets a private token for subscribing to a DonationAlerts channel via Centrifuge.
- *
- * @example
- * import { connectPrivateToken } from "../index.js";
- *
- * // 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

@@ -1,46 +0,0 @@
-import axios from "axios";
-import { validateDataObject } from "../utils.js";
-/**
- * Gets a private token for subscribing to a DonationAlerts channel via Centrifuge.
- *
- * @example
- * import { connectPrivateToken } from "../index.js";
- *
- * // 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

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

@@ -1,38 +0,0 @@
-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

@@ -1,19 +0,0 @@
-/**
- * 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

@@ -1,32 +0,0 @@
-/**
- * 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

@@ -1,24 +0,0 @@
-import { UpdateTokenData, OauthToken } from "../types.js";
-/**
- * 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>;

package/dist/src/func/updateAccessToken.js

@@ -1,39 +0,0 @@
-import axios from "axios";
-import { validateDataObject } from "../utils.js";
-/**
- * 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/types.d.ts

@@ -1,33 +0,0 @@
-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/ws/CentrifugeClient.d.ts

@@ -1,31 +0,0 @@
-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

@@ -1,71 +0,0 @@
-import { getPrivateToken } from "../index.js";
-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/src/example/getAuthorizeLink.ts

@@ -1,11 +0,0 @@
-import { getAuthorizeLink } from "@kash-88/alerts";
-
-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 });
-    console.log("Authorize link:", link);
-} catch (error: any) {
-    console.error("Error:", error.message);
-} 

package/src/example/getOauthToken.ts

@@ -1,16 +0,0 @@
-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 code = "CLIENT_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

@@ -1,12 +0,0 @@
-import { getUser } from "@kash-88/alerts";
-
-const access_token = 'USER_ACCESS_TOKEN';
-
-(async () => {
-    try {
-        const user = await getUser(access_token);
-        console.log("User:", user);
-    } catch (error: any) {
-        console.error("Error:", error.message);
-    }
-})();