@mercuryhq/n8n-nodes-twitch 1.9.0

package/LICENSE

@@ -0,0 +1,22 @@
+The MIT License
+
+Copyright (c) 2025 Codely Enseña y Entretiene SL. https://codely.com
+Copyright (c) 2026 NBDBatman//MercuryHQ
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/README.md

@@ -0,0 +1,203 @@
+# 🛠 Twitch node for n8n (fork)
+
+Trigger workflows on stream start or stream end, search for Twitch streams details…
+
+## Credits
+
+This project is a fork of the original CodelyTV Twitch node for n8n.
+Thanks to CodelyTV for the foundation and ongoing open-source work.
+
+Original project:
+- Repository: `https://github.com/CodelyTV/n8n-nodes-twitch`
+- Organization: `https://github.com/CodelyTV`
+
+## Differences From Upstream (CodelyTV)
+
+- Expanded the Twitch node with a much larger set of actions and EventSub triggers (see `TWITCH_API_COVERAGE.md`).
+- Switched credentials to OAuth2 with scopes and bearer tokens instead of app-only tokens.
+- Added a `Run Once (Ignore Item Inputs)` toggle to prevent duplicate output when multiple input items exist.
+- Enforced per-operation limits, including separate max limits for Polls (20) and Predictions (25).
+- Removed deprecated/unused endpoints (e.g., Hype Train status, Drops entitlements, and stream tags).
+
+# 👀 n8n Twitch node features
+
+Once installed, you will be able to add Twitch triggers and actions to your n8n workflows.
+
+1. Search for Twitch node:
+
+   <img alt="Twitch node in the n8n nodes panel" src="/docs/node.png" width="336" height="180">
+
+2. Select the desired action or trigger:
+
+   <img alt="Twitch node triggers" src="/docs/node-actions-and-triggers.png" width="336" height="504">
+
+3. Parametrize it:
+
+   <img alt="Twitch node parameters" src="/docs/node-parameters.png" width="336" height="350">
+
+# 🚀 Installation instructions
+
+This node is in the process to be officially verified by n8n.
+The installation process will be as simple as searching for "Twitch" in the nodes panel once we get that verification,
+but in the meantime, you have several options that depend on how you use n8n.
+
+We recommend checking out the [updated n8n instructions
+on how to install community nodes](https://docs.n8n.io/integrations/community-nodes/installation/) for possible updates to this process.
+
+## a) n8n cloud instance
+
+It is not possible to install unverified community nodes in n8n cloud ([documentation](https://docs.n8n.io/integrations/community-nodes/installation/)).
+Once we get that verification, you will be able to install this node following [this step by step](https://docs.n8n.io/integrations/community-nodes/installation/verified-install/).
+
+## b) Self-hosted n8n instance
+
+### b.a) Not using queue mode: GUI installation
+
+Follow [the official instructions](https://docs.n8n.io/integrations/community-nodes/installation/gui-install/)
+specifying `@codelytv/n8n-nodes-twitch` as the node name to install:
+
+<img alt="Twitch community node installation" src="/docs/node-installation.png" width="336" height="241">
+
+## b.b) Using queue mode
+
+### b.b.a) Install as npm package
+
+This is the officially recommended way for self-hosted n8n instances running in queue mode ([documentation](https://docs.n8n.io/integrations/community-nodes/installation/manual-install/).
+
+Go to the folder where n8n is installed (if you are using the standard Docker installation, it will probably be:
+`/usr/local/lib/node_modules/n8n`) and install the package as any other npm package:
+
+```bash
+npm i @codelytv/n8n-nodes-twitch
+```
+
+### b.b.b) Install as Custom Docker image
+
+`Dockerfile` contents example for a custom image with this node added:
+
+```dockerfile
+ARG N8N_VERSION
+FROM n8nio/n8n:${N8N_VERSION}
+
+RUN if [ -z "$N8N_VERSION" ]; then echo "💥 N8N_VERSION argument missing."; exit 1; fi && \
+    mkdir -p /home/node/.n8n/nodes && \
+    npm install --prefix /home/node/.n8n/nodes --production --silent @codelytv/n8n-nodes-twitch
+```
+
+### b.b.c) Install using Docker Compose / Docker Swarm with mapped volume
+
+Take into account that this option has a considerable downside:
+The workflows you create will contain `CUSTOM.twitchTrigger` as the node type reference instead of `@codelytv/n8n-nodes-twitch.twitchTrigger`. However, it could be the best approach if you want a faster feedback loop while developing.
+Take into account that localhost will not be reachable from Twitch, so you `probably are interested into exposing it with a tunnel using something like `cloudflared`, or just expose a remote host to Twitch.
+
+Docker Compose / Docker Swarm definition snippet:
+
+```yaml
+volumes:
+  n8n_data:
+    name: '{{.Service.Name}}_{{.Task.Slot}}'
+
+services:
+  n8n-main:
+    volumes:
+      - n8n_data:/home/node/.n8n
+      - /home/codely/n8n-custom-nodes:/home/node/.n8n/custom
+```
+
+Deploy process:
+
+```bash
+CUSTOM_NODES_DIR="$HOME/n8n-custom-nodes"
+
+mkdir -p "$CUSTOM_NODES_DIR"
+
+docker run --rm \
+  --user "$(id -u):$(id -g)" \
+  -v "$CUSTOM_NODES_DIR":/data \
+  -w /data \
+  node:22-alpine \
+  sh -c "npm install @codelytv/n8n-nodes-twitch --production --silent"
+
+docker stack deploy -c n8n-swarm.yml n8n
+```
+
+# 🔑 How to get Twitch credentials
+
+You will need to create a new Twitch application to get Client ID and Client Secret following these steps:
+
+1. Go to the [Twitch Developer Console](https://dev.twitch.tv/console/apps).
+2. Log in using your Twitch account credentials.
+3. Click on the "+ Register Your Application" button.
+4. Fill out the form as follows and click "Create":
+   - Name: Name your app (e.g., “n8nTwitchBot”).
+   - OAuth Redirect URLs: Use a valid redirect URL.
+     Something like http://localhost:5678/rest/oauth2-credential/callback works.
+     We do not plan to display Twitch authentication to end users with Oauth.
+     We're only interested in getting the Client ID and Client Secret, so it's fine to specify a local URL.
+   - Category: Application Integration
+   - Client Type: Confidential
+5. Get your credentials:
+   - Click on "Manage"
+   - Client ID: Visible right away.
+   - Client Secret: Click "New Secret" to generate one. Be sure to store this securely (it won’t be shown again).
+
+# 💻 Documentation for node contributors
+
+How to locally test this node (based on [the official n8n guide](https://docs.n8n.io/integrations/creating-nodes/test/run-node-locally/)):
+
+1. Clone and move to the node development folder
+   ```bash
+   cd ~/Code/work/codely/public/
+   git clone git@github.com:CodelyTV/n8n-nodes-twitch.git
+   cd n8n-nodes-twitch
+   ```
+2. Build the node
+   ```bash
+   npm run build
+   ```
+3. Create a npm global symlink to the locally installed package 
+   ```bash
+   npm link
+   ```
+4. Install n8n locally:
+   ```bash
+   npm install n8n -g
+   ```
+5. Move to your n8n local installation
+   ```bash
+   cd ~/.n8n/
+   ```
+6. Create a custom nodes folder
+    ```bash
+    mkdir custom
+    cd custom
+7. Link the node package to the symlink previously created
+    ```bash
+    npm link @codelytv/n8n-nodes-twitch
+    ```
+8. Validate that the local n8n instance has the Twitch node pointing to the local folder
+   ```bash
+   tree -L 3 -d
+   ```
+   Expected output:
+   ```bash
+   .
+   └── node_modules
+       └── @codelytv
+           └── n8n-nodes-twitch -> ../../../../Code/work/codely/public/n8n-nodes-twitch
+   ```
+9. Run n8n
+    ```bash
+    n8n start
+    ```
+10. Enjoy!
+
+# 👌 Code Quality Standards
+
+Publishing this package we are committing ourselves to the following code quality standards:
+
+- 🤝 Respect **Semantic Versioning**: No breaking changes in patch or minor versions
+- 🤏 No surprises in transitive dependencies: Use the **bare minimum dependencies** needed to meet the purpose
+- 🎯 **One specific purpose** to meet without having to carry a bunch of unnecessary other utilities
+- 📖 **Well documented ReadMe** showing how to install and use
+- ⚖️ **License favoring Open Source** and collaboration

package/dist/credentials/TwitchApi.credentials.d.ts

@@ -0,0 +1,9 @@
+import { ICredentialTestRequest, ICredentialType, INodeProperties } from 'n8n-workflow';
+export declare class TwitchApi implements ICredentialType {
+    name: string;
+    displayName: string;
+    documentationUrl: string;
+    extends: string[];
+    properties: INodeProperties[];
+    test: ICredentialTestRequest;
+}

package/dist/credentials/TwitchApi.credentials.js

@@ -0,0 +1,70 @@
+export class TwitchApi {
+    constructor() {
+        this.name = 'twitchApi';
+        this.displayName = 'Twitch API';
+        this.documentationUrl = 'https://github.com/CodelyTV/n8n-nodes-twitch?tab=readme-ov-file#-how-to-get-twitch-credentials';
+        this.extends = ['oAuth2Api'];
+        this.properties = [
+            {
+                displayName: 'Grant Type',
+                name: 'grantType',
+                type: 'hidden',
+                default: 'authorizationCode',
+            },
+            {
+                displayName: 'Authorization URL',
+                name: 'authUrl',
+                type: 'string',
+                default: 'https://id.twitch.tv/oauth2/authorize',
+            },
+            {
+                displayName: 'Access Token URL',
+                name: 'accessTokenUrl',
+                type: 'string',
+                default: 'https://id.twitch.tv/oauth2/token',
+            },
+            {
+                displayName: 'Authentication',
+                name: 'authentication',
+                type: 'hidden',
+                default: 'body',
+            },
+            {
+                displayName: 'Client ID',
+                name: 'clientId',
+                type: 'string',
+                default: '',
+            },
+            {
+                displayName: 'Client Secret',
+                name: 'clientSecret',
+                type: 'string',
+                typeOptions: { password: true },
+                default: '',
+            },
+            {
+                displayName: 'Scope',
+                name: 'scope',
+                type: 'string',
+                default: 'analytics:read:extensions analytics:read:games bits:read channel:bot channel:edit:commercial channel:manage:ads channel:manage:broadcast channel:manage:clips channel:manage:extensions channel:manage:guest_star channel:manage:moderators channel:manage:polls channel:manage:predictions channel:manage:raids channel:manage:redemptions channel:manage:schedule channel:manage:videos channel:manage:vips channel:moderate channel:read:ads channel:read:charity channel:read:editors channel:read:goals channel:read:guest_star channel:read:hype_train channel:read:polls channel:read:predictions channel:read:redemptions channel:read:stream_key channel:read:subscriptions channel:read:vips clips:edit editor:manage:clips moderation:read moderator:manage:announcements moderator:manage:automod moderator:manage:automod_settings moderator:manage:banned_users moderator:manage:blocked_terms moderator:manage:chat_messages moderator:manage:chat_settings moderator:manage:guest_star moderator:manage:shield_mode moderator:manage:shoutouts moderator:manage:suspicious_users moderator:manage:unban_requests moderator:manage:warnings moderator:read:automod_settings moderator:read:banned_users moderator:read:blocked_terms moderator:read:chat_messages moderator:read:chat_settings moderator:read:chatters moderator:read:followers moderator:read:guest_star moderator:read:moderators moderator:read:shield_mode moderator:read:shoutouts moderator:read:suspicious_users moderator:read:unban_requests moderator:read:vips moderator:read:warnings user:bot user:edit user:edit:broadcast user:manage:blocked_users user:manage:chat_color user:manage:whispers user:read:blocked_users user:read:broadcast user:read:chat user:read:email user:read:emotes user:read:follows user:read:moderated_channels user:read:subscriptions user:read:whispers user:write:chat',
+                description: 'Space-separated list of scopes to request (add required scopes for the endpoints you use)',
+            },
+        ];
+        this.test = {
+            request: {
+                baseURL: 'https://id.twitch.tv',
+                url: '/oauth2/token',
+                method: 'POST',
+                headers: {
+                    'Content-Type': 'application/json',
+                },
+                qs: {
+                    client_id: '={{$credentials.clientId}}',
+                    client_secret: '={{$credentials.clientSecret}}',
+                    grant_type: 'client_credentials',
+                },
+            },
+        };
+    }
+}
+//# sourceMappingURL=TwitchApi.credentials.js.map

package/dist/credentials/TwitchApi.credentials.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TwitchApi.credentials.js","sourceRoot":"","sources":["../../credentials/TwitchApi.credentials.ts"],"names":[],"mappings":"AAMA,MAAM,OAAO,SAAS;IAAtB;QACC,SAAI,GAAG,WAAW,CAAC;QACnB,gBAAW,GAAG,YAAY,CAAC;QAC3B,qBAAgB,GAAG,gGAAgG,CAAC;QACpH,YAAO,GAAG,CAAC,WAAW,CAAC,CAAC;QACxB,eAAU,GAAsB;YAC/B;gBACC,WAAW,EAAE,YAAY;gBACzB,IAAI,EAAE,WAAW;gBACjB,IAAI,EAAE,QAAQ;gBACd,OAAO,EAAE,mBAAmB;aAC5B;YACD;gBACC,WAAW,EAAE,mBAAmB;gBAChC,IAAI,EAAE,SAAS;gBACf,IAAI,EAAE,QAAQ;gBACd,OAAO,EAAE,uCAAuC;aAChD;YACD;gBACC,WAAW,EAAE,kBAAkB;gBAC/B,IAAI,EAAE,gBAAgB;gBACtB,IAAI,EAAE,QAAQ;gBACd,OAAO,EAAE,mCAAmC;aAC5C;YACD;gBACC,WAAW,EAAE,gBAAgB;gBAC7B,IAAI,EAAE,gBAAgB;gBACtB,IAAI,EAAE,QAAQ;gBACd,OAAO,EAAE,MAAM;aACf;YACD;gBACC,WAAW,EAAE,WAAW;gBACxB,IAAI,EAAE,UAAU;gBAChB,IAAI,EAAE,QAAQ;gBACd,OAAO,EAAE,EAAE;aACX;YACD;gBACC,WAAW,EAAE,eAAe;gBAC5B,IAAI,EAAE,cAAc;gBACpB,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE;gBAC/B,OAAO,EAAE,EAAE;aACX;YACD;gBACC,WAAW,EAAE,OAAO;gBACpB,IAAI,EAAE,OAAO;gBACb,IAAI,EAAE,QAAQ;gBACd,OAAO,EAAE,qyDAAqyD;gBAC9yD,WAAW,EAAE,2FAA2F;aACxG;SACD,CAAC;QAEF,SAAI,GAA2B;YAC9B,OAAO,EAAE;gBACR,OAAO,EAAE,sBAAsB;gBAC/B,GAAG,EAAE,eAAe;gBACpB,MAAM,EAAE,MAAM;gBACd,OAAO,EAAE;oBACR,cAAc,EAAE,kBAAkB;iBAClC;gBACD,EAAE,EAAE;oBACH,SAAS,EAAE,4BAA4B;oBACvC,aAAa,EAAE,gCAAgC;oBAC/C,UAAU,EAAE,oBAAoB;iBAChC;aACD;SACD,CAAC;IACH,CAAC;CAAA"}

package/dist/nodes/Twitch/GenericFunctions.d.ts

@@ -0,0 +1,3 @@
+import { IDataObject, IExecuteFunctions, IHookFunctions, ILoadOptionsFunctions, INodePropertyOptions, IWebhookFunctions } from 'n8n-workflow';
+export declare function twitchApiRequest(this: IExecuteFunctions | IWebhookFunctions | IHookFunctions | ILoadOptionsFunctions, method: string, resource: string, body?: any, query?: IDataObject, option?: IDataObject): Promise<any>;
+export declare function getChannels(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]>;

package/dist/nodes/Twitch/GenericFunctions.js

@@ -0,0 +1,60 @@
+export async function twitchApiRequest(method, resource, body = {}, query = {}, option = {}) {
+    var _a;
+    const credentials = (await this.getCredentials('twitchApi'));
+    const clientId = credentials.clientId;
+    const endpoint = 'https://api.twitch.tv/helix';
+    const options = {
+        headers: {
+            'Content-Type': 'application/json',
+            'Client-Id': clientId,
+        },
+        method: method,
+        body,
+        qs: query,
+        url: `${endpoint}${resource}`,
+        json: true,
+    };
+    if (!Object.keys(body).length) {
+        delete options.body;
+    }
+    if (!Object.keys(query).length) {
+        delete options.qs;
+    }
+    const optionObj = option;
+    const optionHeaders = (_a = optionObj.headers) !== null && _a !== void 0 ? _a : {};
+    const requestOptions = {
+        ...options,
+        ...optionObj,
+        headers: {
+            ...(options.headers || {}),
+            ...optionHeaders,
+        },
+    };
+    try {
+        return await this.helpers.requestWithAuthentication.call(this, 'twitchApi', requestOptions);
+    }
+    catch (errorObject) {
+        if (errorObject.error) {
+            const errorMessage = errorObject.error.message;
+            throw new Error(`Twitch API error response [${errorObject.error.status}]: ${errorMessage}`);
+        }
+        throw errorObject;
+    }
+}
+export async function getChannels() {
+    const returnData = [];
+    const channels = await twitchApiRequest.call(this, 'GET', '/search/channels', {}, { query: this.getNodeParameter('userLogin', 0) });
+    if (channels.data === undefined) {
+        throw new Error('No channels found');
+    }
+    for (const channel of channels.data) {
+        const channelName = channel.display_name;
+        const channelId = channel.id;
+        returnData.push({
+            name: channelName,
+            value: channelId,
+        });
+    }
+    return returnData;
+}
+//# sourceMappingURL=GenericFunctions.js.map

package/dist/nodes/Twitch/GenericFunctions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"GenericFunctions.js","sourceRoot":"","sources":["../../../nodes/Twitch/GenericFunctions.ts"],"names":[],"mappings":"AAWA,MAAM,CAAC,KAAK,UAAU,gBAAgB,CAMrC,MAAc,EACd,QAAgB,EAChB,OAAY,EAAE,EACd,QAAqB,EAAE,EACvB,SAAsB,EAAE;;IAIxB,MAAM,WAAW,GAAG,CAAC,MAAM,IAAI,CAAC,cAAc,CAAC,WAAW,CAAC,CAAgB,CAAC;IAE5E,MAAM,QAAQ,GAAG,WAAW,CAAC,QAAQ,CAAC;IAEtC,MAAM,QAAQ,GAAG,6BAA6B,CAAC;IAC/C,MAAM,OAAO,GAAwB;QACpC,OAAO,EAAE;YACR,cAAc,EAAE,kBAAkB;YAClC,WAAW,EAAE,QAAQ;SACrB;QACD,MAAM,EAAE,MAA6B;QACrC,IAAI;QACJ,EAAE,EAAE,KAAK;QACT,GAAG,EAAE,GAAG,QAAQ,GAAG,QAAQ,EAAE;QAC7B,IAAI,EAAE,IAAI;KACV,CAAC;IACF,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,CAAC;QAC/B,OAAO,OAAO,CAAC,IAAI,CAAC;IACrB,CAAC;IACD,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,MAAM,EAAE,CAAC;QAChC,OAAO,OAAO,CAAC,EAAE,CAAC;IACnB,CAAC;IAED,MAAM,SAAS,GAAG,MAAqB,CAAC;IACxC,MAAM,aAAa,GAAG,MAAC,SAAS,CAAC,OAAmC,mCAAI,EAAE,CAAC;IAC3E,MAAM,cAAc,GAAwB;QAC3C,GAAG,OAAO;QACV,GAAG,SAAS;QACZ,OAAO,EAAE;YACR,GAAG,CAAC,OAAO,CAAC,OAAO,IAAI,EAAE,CAAC;YAC1B,GAAG,aAAa;SAChB;KACD,CAAC;IAEF,IAAI,CAAC;QACJ,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,yBAAyB,CAAC,IAAI,CAAC,IAAI,EAAE,WAAW,EAAE,cAAc,CAAC,CAAC;IAC7F,CAAC;IAAC,OAAO,WAAgB,EAAE,CAAC;QAC3B,IAAI,WAAW,CAAC,KAAK,EAAE,CAAC;YACvB,MAAM,YAAY,GAAG,WAAW,CAAC,KAAK,CAAC,OAAO,CAAC;YAC/C,MAAM,IAAI,KAAK,CACd,8BAA8B,WAAW,CAAC,KAAK,CAAC,MAAM,MAAM,YAAY,EAAE,CAC1E,CAAC;QACH,CAAC;QACD,MAAM,WAAW,CAAC;IACnB,CAAC;AACF,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,WAAW;IAChC,MAAM,UAAU,GAA2B,EAAE,CAAC;IAC9C,MAAM,QAAQ,GAAG,MAAM,gBAAgB,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,kBAAkB,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,IAAI,CAAC,gBAAgB,CAAC,WAAW,EAAE,CAAC,CAAW,EAAC,CAAC,CAAC;IAE7I,IAAI,QAAQ,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;QACjC,MAAM,IAAI,KAAK,CAAC,mBAAmB,CAAC,CAAC;IACtC,CAAC;IAED,KAAK,MAAM,OAAO,IAAI,QAAQ,CAAC,IAAI,EAAE,CAAC;QACrC,MAAM,WAAW,GAAG,OAAO,CAAC,YAAY,CAAC;QACzC,MAAM,SAAS,GAAG,OAAO,CAAC,EAAE,CAAC;QAE7B,UAAU,CAAC,IAAI,CAAC;YACf,IAAI,EAAE,WAAW;YACjB,KAAK,EAAE,SAAS;SAChB,CAAC,CAAC;IACJ,CAAC;IAED,OAAO,UAAU,CAAC;AACnB,CAAC"}

package/dist/nodes/Twitch/Twitch.node.d.ts

@@ -0,0 +1,5 @@
+import { IExecuteFunctions, INodeType, INodeTypeDescription } from "n8n-workflow";
+export declare class Twitch implements INodeType {
+    description: INodeTypeDescription;
+    execute(this: IExecuteFunctions): Promise<import("n8n-workflow").INodeExecutionData[][]>;
+}