Support Twitch Gifting messages

[tmtrademark]

Twitch introduced a new feature which appears to add a new USERNOTICE message with a new msg-id.

https://blog.twitch.tv/give-the-gift-of-twitch-with-subscription-gifting-af4532ee137c

Would be great to have this supported by tmi.js

[Borengar]

Just some quick USERNOTICE information to help. Maybe if i can find out how to work with git i will create a pull request.

{ badges: { moderator: '1', subscriber: '24', bits: '10000' }, color: '#0003CC', 'display-name': 'Praise_Poiism', emotes: null, id: '6725e649-c7a8-49ba-82a5-8753dce9c0cd', login: 'praise_poiism', mod: true, 'msg-id': 'subgift', 'msg-param-months': true, 'msg-param-recipient-display-name': 'Nightbot', 'msg-param-recipient-id': '19264788', 'msg-param-recipient-user-name': 'nightbot', 'msg-param-sub-plan-name': 'Channel\\sSubscription\\s(happystick)', 'msg-param-sub-plan': '1000', 'room-id': '33002242', subscriber: true, 'system-msg': 'Praise_Poiism\\sgifted\\sa\\s$4.99\\ssub\\sto\\sNightbot!', 'tmi-sent-ts': '1510858536611', turbo: false, 'user-id': '89841025', 'user-type': 'mod', 'emotes-raw': null, 'badges-raw': 'moderator/1,subscriber/24,bits/10000' }

[wobYY]

Well if you want to you can add it yourself in the node_modules/tmi.js/lib/client.js

I added this at line 606(Screenshot):

// Handle subgift
                    else if (msgid == "subgift") {
                        var username = message.tags["display-name"] || message.tags["login"];
                        var recipient = message.tags["msg-param-recipient-display-name"] || message.tags["login"];
                        var plan = message.tags["msg-param-sub-plan"];
                        var planName = _.replaceAll(_.get(message.tags["msg-param-sub-plan-name"], null), {
                            "\\\\s": " ",
                            "\\\\:": ";",
                            "\\\\\\\\": "\\",
                            "\\r": "\r",
                            "\\n": "\n"
                        });
                        var prime = plan.includes("Prime");
                        var userstate = null;

                        if (msg) {
                            userstate = message.tags;
                            userstate['message-type'] = 'subgift';
                        }

                        this.emit("subgift", channel, username, {prime, plan, planName}, msg, userstate);
                    }

How to use it(wasn't sure if msg is always null so i left it there, the important thing is, it works and i'm fine with it as long as it works 😄):
Screenshot

I tested it in summit's chat, it worked so I'm fine

EDIT: No Prime, so can remove that. Edited the script again, testing it atm

EDIT 2: Excuse my stupidness, it's 1AM where I live, I'm not able to fall asleep so I thought I might as well add this to my bot.

New client.js code:

// Handle subgift
                    else if (msgid == "subgift") {
                        var username = message.tags["display-name"] || message.tags["login"];
                        var recipient = message.tags["msg-param-recipient-display-name"] || message.tags["login"];
                        var plan = message.tags["msg-param-sub-plan"];
                        var planName = _.replaceAll(_.get(message.tags["msg-param-sub-plan-name"], null), {
                            "\\\\s": " ",
                            "\\\\:": ";",
                            "\\\\\\\\": "\\",
                            "\\r": "\r",
                            "\\n": "\n"
                        });
                        var userstate = message.tags;

                        this.emit("subgift", channel, username, {plan, planName}, userstate);
                    }

[yat0tv]

I might be missing something but it looks like the emit is missing any reference to the recipient
I'm using your changes as a base for what I want, as I want both the gifter name and id same for the giftee

[Borengar]

Name and id should be in userstate for both gifter and giftee, see my first comment in this issue.
Gifter name is username
Gifter id is userstate['user-id']
Giftee name is recipient
Giftee id is userstate['msg-param-recipient-id']

[Borengar]

Added the changes done by @OfficialwobY to #263

[metal-messiah]

@Borengar I think @yat0tv means that the emit function in the snippet does not include the recipient param.

this is the snippet supplied above
this.emit("subgift", channel, username, {plan, planName}, userstate);

this is what it probably should be
this.emit("subgift", channel, username, recipient, {plan, planName}, userstate);

[TheTimmaeh]

var recipient = message.tags["msg-param-recipient-display-name"] || message.tags["login"];
should be
var recipient = message.tags["msg-param-recipient-display-name"] || message.tags["msg-param-recipient-user-name"];
because "login" contains the gifter, not the recipient.

With the fixed emit, the code I used looks like this:

                    // Handle subgift
                    else if (msgid == "subgift") {
                        var username = message.tags["display-name"] || message.tags["login"];
                        var recipient = message.tags["msg-param-recipient-display-name"] || message.tags["msg-param-recipient-user-name"];
                        var plan = message.tags["msg-param-sub-plan"];
                        var planName = _.replaceAll(_.get(message.tags["msg-param-sub-plan-name"], null), {
                            "\\\\s": " ",
                            "\\\\:": ";",
                            "\\\\\\\\": "\\",
                            "\\r": "\r",
                            "\\n": "\n"
                        });
                        var userstate = message.tags;

                        this.emit("subgift", channel, username, recipient, {plan, planName}, userstate);
                    }

[azazael13]

Does the usernotice now also send how many subs a person has gifted to a channel? I am not sure how to capture those so I can't check myself.

[azazael13]

Anyone? Is there a way to at least send the emait messages to the console so I can see them and attempt to debug it myself.

[azazael13]

Was this closed because it has been updated? My question from Jun 8th still stands.

[AlcaDesign]

Updated with c06d766 -- Available in upcoming 1.4.0, which might be released later today.

And for #262 (comment), yes and you can get that from the userstate.