@elara-services/twitter v2.0.4

What is this package?

This announces / tells you when someone posts.

Support Server

https://my.elara.services/support

Getting Started

Note: For this package you need 1 string from the Twitter developer page. bearer_token is required for this package to work properly.

Creating the Twitter client

const { Twitter } = require("@elara-services/twitter");
const twitter = new Twitter({
    BearerToken: "Your bearer_token from the Twitter developer page.",
    defaultAnnouncements: true, // For the default announcement embeds (if set to false then it won't announce anything, you'll have to listen to the 'stream:post' event to create and announce with your own custom content / embeds)
    updateRulesOnStart: true, // For the package to automatically update the Twitter Stream-V2 rules 
})

Adding Users

twitter.addUser({ 
    name: "The Twitter user's username", // [REQUIRED]: The Twitter user's full username (NOT DISPLAY NAME)
    color: 0xFF0000, // [NOT_REQUIRED]: The embed's color
    webhooks: [ // [REQUIRED]: The webhook urls to announce the tweets in for the creator
        "https://discord.com/api/webhooks/..."
    ]
})
// OR For multiple users

twitter.addUsers([
    { 
        name: "The Twitter user's username", // [REQUIRED]: The Twitter user's full username (NOT DISPLAY NAME)
        color: 0xFF0000, // [NOT_REQUIRED]: The embed's color
        webhooks: [ // [REQUIRED]: The webhook urls to announce the tweets in for the creator
            "https://discord.com/api/webhooks/..."
        ]
    },
    { ... }
])

Starting the Twitter Stream

await twitter.start()
// This will start the twitter stream for the provided users.
// NOTE: You have to restart the twitter stream if you want to add more users! (THIS IS A TWITTER STREAM API LIMITATION)

Listening to Events

// Stream Start
twitter.on("stream:start", ({ start }) => console.log(`The twitter stream started!`, start));

// Stream End
twitter.on("stream:disconnect", (response) => console.log(`The twitter stream disconnect!`, response));

// Stream Error
twitter.on("stream:error", (error) => console.warn(`The twitter stream had an error!`, error));

// Stream Post
twitter.on("stream:post", (body, user) => console.log(`New tweet!`, body, user));
// User should always return { id: string, color: string | number, webhooks: [] }

// Webhook Errors
twitter.on("webhook:error", (error) => console.log(`We've hit an error while sending to the webhook!`, error));

Formatting the Twitter Post Data

const body = twitter.fetchData(postData, userData);
console.log(body);
// Note: This can return 'null' and 'userData' isn't required for this function

Fetching a user

const user = await twitter.fetchUser("SUPERCHIEFYT").catch(() => {});
console.log(user);
// Returns the fetched user data 

Customizing the Twitter announcements

twitter.on("stream:post", async (post) => {
    const user = post.includes.users.find(c => c.id === post.data.author_id);
    if (!user) return;
    let data = twitter.fetchData(post, twitter.data.find(c => c.name === user.name));
    if (!data) return;
    return twitter.send({
        webhook: data.webhooks,
        username: "Whatever you want the webhook's name to be called",
        avatar_url: "The image url you want the webhook to have",
        content: "Message Content, if you want it",
        embeds: [
            {
                title: "Customize the embed(s)"
            }
        ],
        components: [] // Add components (ONLY WORKS FOR APPLICATION/BOT OWNED WEBHOOKS, DISCORD LIMITATION)
    })

    // NOTE: 'content', 'embeds' or 'components' You need one of those for anything to be sent!
})