@donlovett/n8n-nodes-youtube-transcript 1.0.0

package/README.md

@@ -0,0 +1,94 @@
+# n8n-nodes-youtube-transcript
+
+This is an n8n community node that fetches transcripts (captions) from YouTube videos.
+
+[n8n](https://n8n.io/) is a [fair-code licensed](https://docs.n8n.io/reference/license/) workflow automation platform.
+
+## Features
+
+- Fetch transcripts from any YouTube video that has captions
+- Support for multiple languages
+- Output as full text or timed segments
+- Automatic video ID extraction from URLs
+- Graceful error handling
+
+## Installation
+
+### Community Node Installation (Recommended)
+
+1. Go to **Settings** > **Community Nodes** in your n8n instance
+2. Select **Install**
+3. Enter `n8n-nodes-youtube-transcript`
+4. Click **Install**
+
+### Manual Installation
+
+```bash
+cd ~/.n8n/custom
+npm install n8n-nodes-youtube-transcript
+```
+
+Then restart n8n.
+
+## Operations
+
+### Get Transcript
+
+Fetches the transcript/captions from a YouTube video.
+
+**Parameters:**
+- **Video ID or URL**: The YouTube video ID (e.g., `dQw4w9WgXcQ`) or full URL
+- **Language**: Language code for the transcript (default: `en`)
+- **Output Format**:
+  - `Full Text` - Returns transcript as a single text string
+  - `Segments` - Returns array of timed segments with start time and duration
+
+**Output:**
+```json
+{
+  "videoId": "dQw4w9WgXcQ",
+  "language": "en",
+  "hasTranscript": true,
+  "transcript": "The full transcript text...",
+  "wordCount": 1234,
+  "segmentCount": 156
+}
+```
+
+## Supported URL Formats
+
+- `https://www.youtube.com/watch?v=VIDEO_ID`
+- `https://youtu.be/VIDEO_ID`
+- `https://youtube.com/embed/VIDEO_ID`
+- Plain video ID: `VIDEO_ID`
+
+## Error Handling
+
+If a video doesn't have a transcript available, the node returns:
+```json
+{
+  "videoId": "...",
+  "hasTranscript": false,
+  "error": "No transcript available for this video",
+  "transcript": "",
+  "wordCount": 0
+}
+```
+
+Enable "Continue On Fail" in the node settings to process multiple videos even if some fail.
+
+## Limitations
+
+- This node uses YouTube's unofficial transcript API
+- Only works with videos that have captions enabled
+- Auto-generated captions may have accuracy issues
+- Rate limiting may apply for high-volume usage
+
+## License
+
+MIT
+
+## Resources
+
+- [n8n Community Nodes Documentation](https://docs.n8n.io/integrations/community-nodes/)
+- [youtube-transcript npm package](https://www.npmjs.com/package/youtube-transcript)

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

@@ -0,0 +1,6 @@
+import { IExecuteFunctions, INodeExecutionData, INodeType, INodeTypeDescription } from 'n8n-workflow';
+export declare class YouTubeTranscript implements INodeType {
+    description: INodeTypeDescription;
+    execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]>;
+}
+//# sourceMappingURL=YouTubeTranscript.node.d.ts.map

package/dist/nodes/YouTubeTranscript/YouTubeTranscript.node.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"YouTubeTranscript.node.d.ts","sourceRoot":"","sources":["../../../nodes/YouTubeTranscript/YouTubeTranscript.node.ts"],"names":[],"mappings":"AAAA,OAAO,EACN,iBAAiB,EACjB,kBAAkB,EAClB,SAAS,EACT,oBAAoB,EAEpB,MAAM,cAAc,CAAC;AA4BtB,qBAAa,iBAAkB,YAAW,SAAS;IAClD,WAAW,EAAE,oBAAoB,CAgF/B;IAEI,OAAO,CAAC,IAAI,EAAE,iBAAiB,GAAG,OAAO,CAAC,kBAAkB,EAAE,EAAE,CAAC;CAqGvE"}

package/dist/nodes/YouTubeTranscript/YouTubeTranscript.node.js

@@ -0,0 +1,197 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.YouTubeTranscript = void 0;
+const n8n_workflow_1 = require("n8n-workflow");
+// @ts-ignore - youtube-transcript doesn't have types
+const youtube_transcript_1 = require("youtube-transcript");
+// Helper function to extract video ID from URL
+function extractVideoId(input) {
+    // Already a video ID (11 characters, alphanumeric with - and _)
+    if (/^[a-zA-Z0-9_-]{11}$/.test(input)) {
+        return input;
+    }
+    // Try to extract from various URL formats
+    const patterns = [
+        /(?:youtube\.com\/watch\?v=|youtu\.be\/|youtube\.com\/embed\/|youtube\.com\/v\/)([a-zA-Z0-9_-]{11})/,
+        /[?&]v=([a-zA-Z0-9_-]{11})/,
+    ];
+    for (const pattern of patterns) {
+        const match = input.match(pattern);
+        if (match) {
+            return match[1];
+        }
+    }
+    return input; // Return as-is and let the API handle validation
+}
+class YouTubeTranscript {
+    constructor() {
+        this.description = {
+            displayName: 'YouTube Transcript',
+            name: 'youTubeTranscript',
+            icon: 'file:youtube.svg',
+            group: ['transform'],
+            version: 1,
+            subtitle: '={{$parameter["operation"]}}',
+            description: 'Fetch transcripts from YouTube videos',
+            defaults: {
+                name: 'YouTube Transcript',
+            },
+            inputs: ['main'],
+            outputs: ['main'],
+            properties: [
+                {
+                    displayName: 'Operation',
+                    name: 'operation',
+                    type: 'options',
+                    noDataExpression: true,
+                    options: [
+                        {
+                            name: 'Get Transcript',
+                            value: 'getTranscript',
+                            description: 'Get the transcript of a YouTube video',
+                            action: 'Get transcript of a youtube video',
+                        },
+                    ],
+                    default: 'getTranscript',
+                },
+                {
+                    displayName: 'Video ID or URL',
+                    name: 'videoId',
+                    type: 'string',
+                    default: '',
+                    required: true,
+                    displayOptions: {
+                        show: {
+                            operation: ['getTranscript'],
+                        },
+                    },
+                    placeholder: 'dQw4w9WgXcQ or https://youtu.be/dQw4w9WgXcQ',
+                    description: 'The YouTube video ID or full URL',
+                },
+                {
+                    displayName: 'Language',
+                    name: 'language',
+                    type: 'string',
+                    default: 'en',
+                    displayOptions: {
+                        show: {
+                            operation: ['getTranscript'],
+                        },
+                    },
+                    description: 'Language code for the transcript (e.g., en, es, de)',
+                },
+                {
+                    displayName: 'Output Format',
+                    name: 'outputFormat',
+                    type: 'options',
+                    options: [
+                        {
+                            name: 'Full Text',
+                            value: 'fullText',
+                            description: 'Return transcript as a single text string',
+                        },
+                        {
+                            name: 'Segments',
+                            value: 'segments',
+                            description: 'Return transcript as an array of timed segments',
+                        },
+                    ],
+                    default: 'fullText',
+                    displayOptions: {
+                        show: {
+                            operation: ['getTranscript'],
+                        },
+                    },
+                    description: 'How to format the transcript output',
+                },
+            ],
+        };
+    }
+    async execute() {
+        const items = this.getInputData();
+        const returnData = [];
+        for (let i = 0; i < items.length; i++) {
+            try {
+                const operation = this.getNodeParameter('operation', i);
+                if (operation === 'getTranscript') {
+                    const videoIdInput = this.getNodeParameter('videoId', i);
+                    const language = this.getNodeParameter('language', i);
+                    const outputFormat = this.getNodeParameter('outputFormat', i);
+                    // Extract video ID from URL if needed
+                    const videoId = extractVideoId(videoIdInput);
+                    if (!videoId) {
+                        throw new n8n_workflow_1.NodeOperationError(this.getNode(), 'Invalid video ID or URL provided', { itemIndex: i });
+                    }
+                    // Fetch transcript
+                    const transcriptSegments = await youtube_transcript_1.YoutubeTranscript.fetchTranscript(videoId, {
+                        lang: language,
+                    });
+                    if (!transcriptSegments || transcriptSegments.length === 0) {
+                        // Return empty result instead of error
+                        returnData.push({
+                            json: {
+                                videoId,
+                                language,
+                                hasTranscript: false,
+                                error: 'No transcript available for this video',
+                                transcript: '',
+                                wordCount: 0,
+                            },
+                        });
+                        continue;
+                    }
+                    if (outputFormat === 'fullText') {
+                        // Combine all segments into a single text
+                        const fullText = transcriptSegments
+                            .map((segment) => segment.text)
+                            .join(' ')
+                            .replace(/\s+/g, ' ')
+                            .trim();
+                        const wordCount = fullText.split(/\s+/).filter((w) => w).length;
+                        returnData.push({
+                            json: {
+                                videoId,
+                                language,
+                                hasTranscript: true,
+                                transcript: fullText,
+                                wordCount,
+                                segmentCount: transcriptSegments.length,
+                            },
+                        });
+                    }
+                    else {
+                        // Return segments with timing
+                        returnData.push({
+                            json: {
+                                videoId,
+                                language,
+                                hasTranscript: true,
+                                segments: transcriptSegments,
+                                segmentCount: transcriptSegments.length,
+                            },
+                        });
+                    }
+                }
+            }
+            catch (error) {
+                if (this.continueOnFail()) {
+                    const videoIdInput = this.getNodeParameter('videoId', i, '');
+                    returnData.push({
+                        json: {
+                            videoId: extractVideoId(videoIdInput),
+                            hasTranscript: false,
+                            error: error instanceof Error ? error.message : 'Unknown error',
+                            transcript: '',
+                            wordCount: 0,
+                        },
+                    });
+                    continue;
+                }
+                throw new n8n_workflow_1.NodeOperationError(this.getNode(), error instanceof Error ? error.message : 'Failed to fetch transcript', { itemIndex: i });
+            }
+        }
+        return [returnData];
+    }
+}
+exports.YouTubeTranscript = YouTubeTranscript;
+//# sourceMappingURL=YouTubeTranscript.node.js.map

package/dist/nodes/YouTubeTranscript/YouTubeTranscript.node.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"YouTubeTranscript.node.js","sourceRoot":"","sources":["../../../nodes/YouTubeTranscript/YouTubeTranscript.node.ts"],"names":[],"mappings":";;;AAAA,+CAMsB;AAEtB,qDAAqD;AACrD,2DAAuD;AAEvD,+CAA+C;AAC/C,SAAS,cAAc,CAAC,KAAa;IACpC,gEAAgE;IAChE,IAAI,qBAAqB,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;QACvC,OAAO,KAAK,CAAC;IACd,CAAC;IAED,0CAA0C;IAC1C,MAAM,QAAQ,GAAG;QAChB,oGAAoG;QACpG,2BAA2B;KAC3B,CAAC;IAEF,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;QAChC,MAAM,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QACnC,IAAI,KAAK,EAAE,CAAC;YACX,OAAO,KAAK,CAAC,CAAC,CAAC,CAAC;QACjB,CAAC;IACF,CAAC;IAED,OAAO,KAAK,CAAC,CAAC,iDAAiD;AAChE,CAAC;AAED,MAAa,iBAAiB;IAA9B;QACC,gBAAW,GAAyB;YACnC,WAAW,EAAE,oBAAoB;YACjC,IAAI,EAAE,mBAAmB;YACzB,IAAI,EAAE,kBAAkB;YACxB,KAAK,EAAE,CAAC,WAAW,CAAC;YACpB,OAAO,EAAE,CAAC;YACV,QAAQ,EAAE,8BAA8B;YACxC,WAAW,EAAE,uCAAuC;YACpD,QAAQ,EAAE;gBACT,IAAI,EAAE,oBAAoB;aAC1B;YACD,MAAM,EAAE,CAAC,MAAM,CAAC;YAChB,OAAO,EAAE,CAAC,MAAM,CAAC;YACjB,UAAU,EAAE;gBACX;oBACC,WAAW,EAAE,WAAW;oBACxB,IAAI,EAAE,WAAW;oBACjB,IAAI,EAAE,SAAS;oBACf,gBAAgB,EAAE,IAAI;oBACtB,OAAO,EAAE;wBACR;4BACC,IAAI,EAAE,gBAAgB;4BACtB,KAAK,EAAE,eAAe;4BACtB,WAAW,EAAE,uCAAuC;4BACpD,MAAM,EAAE,mCAAmC;yBAC3C;qBACD;oBACD,OAAO,EAAE,eAAe;iBACxB;gBACD;oBACC,WAAW,EAAE,iBAAiB;oBAC9B,IAAI,EAAE,SAAS;oBACf,IAAI,EAAE,QAAQ;oBACd,OAAO,EAAE,EAAE;oBACX,QAAQ,EAAE,IAAI;oBACd,cAAc,EAAE;wBACf,IAAI,EAAE;4BACL,SAAS,EAAE,CAAC,eAAe,CAAC;yBAC5B;qBACD;oBACD,WAAW,EAAE,6CAA6C;oBAC1D,WAAW,EAAE,kCAAkC;iBAC/C;gBACD;oBACC,WAAW,EAAE,UAAU;oBACvB,IAAI,EAAE,UAAU;oBAChB,IAAI,EAAE,QAAQ;oBACd,OAAO,EAAE,IAAI;oBACb,cAAc,EAAE;wBACf,IAAI,EAAE;4BACL,SAAS,EAAE,CAAC,eAAe,CAAC;yBAC5B;qBACD;oBACD,WAAW,EAAE,qDAAqD;iBAClE;gBACD;oBACC,WAAW,EAAE,eAAe;oBAC5B,IAAI,EAAE,cAAc;oBACpB,IAAI,EAAE,SAAS;oBACf,OAAO,EAAE;wBACR;4BACC,IAAI,EAAE,WAAW;4BACjB,KAAK,EAAE,UAAU;4BACjB,WAAW,EAAE,2CAA2C;yBACxD;wBACD;4BACC,IAAI,EAAE,UAAU;4BAChB,KAAK,EAAE,UAAU;4BACjB,WAAW,EAAE,iDAAiD;yBAC9D;qBACD;oBACD,OAAO,EAAE,UAAU;oBACnB,cAAc,EAAE;wBACf,IAAI,EAAE;4BACL,SAAS,EAAE,CAAC,eAAe,CAAC;yBAC5B;qBACD;oBACD,WAAW,EAAE,qCAAqC;iBAClD;aACD;SACD,CAAC;IAuGH,CAAC;IArGA,KAAK,CAAC,OAAO;QACZ,MAAM,KAAK,GAAG,IAAI,CAAC,YAAY,EAAE,CAAC;QAClC,MAAM,UAAU,GAAyB,EAAE,CAAC;QAE5C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YACvC,IAAI,CAAC;gBACJ,MAAM,SAAS,GAAG,IAAI,CAAC,gBAAgB,CAAC,WAAW,EAAE,CAAC,CAAW,CAAC;gBAElE,IAAI,SAAS,KAAK,eAAe,EAAE,CAAC;oBACnC,MAAM,YAAY,GAAG,IAAI,CAAC,gBAAgB,CAAC,SAAS,EAAE,CAAC,CAAW,CAAC;oBACnE,MAAM,QAAQ,GAAG,IAAI,CAAC,gBAAgB,CAAC,UAAU,EAAE,CAAC,CAAW,CAAC;oBAChE,MAAM,YAAY,GAAG,IAAI,CAAC,gBAAgB,CAAC,cAAc,EAAE,CAAC,CAAW,CAAC;oBAExE,sCAAsC;oBACtC,MAAM,OAAO,GAAG,cAAc,CAAC,YAAY,CAAC,CAAC;oBAE7C,IAAI,CAAC,OAAO,EAAE,CAAC;wBACd,MAAM,IAAI,iCAAkB,CAC3B,IAAI,CAAC,OAAO,EAAE,EACd,kCAAkC,EAClC,EAAE,SAAS,EAAE,CAAC,EAAE,CAChB,CAAC;oBACH,CAAC;oBAED,mBAAmB;oBACnB,MAAM,kBAAkB,GAAG,MAAM,sCAAiB,CAAC,eAAe,CAAC,OAAO,EAAE;wBAC3E,IAAI,EAAE,QAAQ;qBACd,CAAC,CAAC;oBAEH,IAAI,CAAC,kBAAkB,IAAI,kBAAkB,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;wBAC5D,uCAAuC;wBACvC,UAAU,CAAC,IAAI,CAAC;4BACf,IAAI,EAAE;gCACL,OAAO;gCACP,QAAQ;gCACR,aAAa,EAAE,KAAK;gCACpB,KAAK,EAAE,wCAAwC;gCAC/C,UAAU,EAAE,EAAE;gCACd,SAAS,EAAE,CAAC;6BACZ;yBACD,CAAC,CAAC;wBACH,SAAS;oBACV,CAAC;oBAED,IAAI,YAAY,KAAK,UAAU,EAAE,CAAC;wBACjC,0CAA0C;wBAC1C,MAAM,QAAQ,GAAG,kBAAkB;6BACjC,GAAG,CAAC,CAAC,OAAyB,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC;6BAChD,IAAI,CAAC,GAAG,CAAC;6BACT,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC;6BACpB,IAAI,EAAE,CAAC;wBAET,MAAM,SAAS,GAAG,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,CAAC,CAAS,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;wBAExE,UAAU,CAAC,IAAI,CAAC;4BACf,IAAI,EAAE;gCACL,OAAO;gCACP,QAAQ;gCACR,aAAa,EAAE,IAAI;gCACnB,UAAU,EAAE,QAAQ;gCACpB,SAAS;gCACT,YAAY,EAAE,kBAAkB,CAAC,MAAM;6BACvC;yBACD,CAAC,CAAC;oBACJ,CAAC;yBAAM,CAAC;wBACP,8BAA8B;wBAC9B,UAAU,CAAC,IAAI,CAAC;4BACf,IAAI,EAAE;gCACL,OAAO;gCACP,QAAQ;gCACR,aAAa,EAAE,IAAI;gCACnB,QAAQ,EAAE,kBAAkB;gCAC5B,YAAY,EAAE,kBAAkB,CAAC,MAAM;6BACvC;yBACD,CAAC,CAAC;oBACJ,CAAC;gBACF,CAAC;YACF,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBAChB,IAAI,IAAI,CAAC,cAAc,EAAE,EAAE,CAAC;oBAC3B,MAAM,YAAY,GAAG,IAAI,CAAC,gBAAgB,CAAC,SAAS,EAAE,CAAC,EAAE,EAAE,CAAW,CAAC;oBACvE,UAAU,CAAC,IAAI,CAAC;wBACf,IAAI,EAAE;4BACL,OAAO,EAAE,cAAc,CAAC,YAAY,CAAC;4BACrC,aAAa,EAAE,KAAK;4BACpB,KAAK,EAAE,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,eAAe;4BAC/D,UAAU,EAAE,EAAE;4BACd,SAAS,EAAE,CAAC;yBACZ;qBACD,CAAC,CAAC;oBACH,SAAS;gBACV,CAAC;gBACD,MAAM,IAAI,iCAAkB,CAC3B,IAAI,CAAC,OAAO,EAAE,EACd,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,4BAA4B,EACrE,EAAE,SAAS,EAAE,CAAC,EAAE,CAChB,CAAC;YACH,CAAC;QACF,CAAC;QAED,OAAO,CAAC,UAAU,CAAC,CAAC;IACrB,CAAC;CACD;AAxLD,8CAwLC"}

package/dist/nodes/YouTubeTranscript/youtube.svg

@@ -0,0 +1,3 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="#FF0000">
+  <path d="M23.498 6.186a3.016 3.016 0 0 0-2.122-2.136C19.505 3.545 12 3.545 12 3.545s-7.505 0-9.377.505A3.017 3.017 0 0 0 .502 6.186C0 8.07 0 12 0 12s0 3.93.502 5.814a3.016 3.016 0 0 0 2.122 2.136c1.871.505 9.376.505 9.376.505s7.505 0 9.377-.505a3.015 3.015 0 0 0 2.122-2.136C24 15.93 24 12 24 12s0-3.93-.502-5.814zM9.545 15.568V8.432L15.818 12l-6.273 3.568z"/>
+</svg>

package/package.json

@@ -0,0 +1,52 @@
+{
+  "name": "@donlovett/n8n-nodes-youtube-transcript",
+  "version": "1.0.0",
+  "description": "n8n node to fetch YouTube video transcripts",
+  "keywords": [
+    "n8n-community-node-package",
+    "youtube",
+    "transcript",
+    "captions"
+  ],
+  "license": "MIT",
+  "author": {
+    "name": "don",
+    "email": "don@projectbitz.com"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/projectbitz/n8n-nodes-youtube-transcript.git"
+  },
+  "main": "dist/index.js",
+  "scripts": {
+    "build": "tsc && gulp build:icons",
+    "dev": "tsc --watch",
+    "format": "prettier nodes --write",
+    "lint": "eslint nodes",
+    "lintfix": "eslint nodes --fix",
+    "prepublishOnly": "npm run build"
+  },
+  "files": [
+    "dist"
+  ],
+  "n8n": {
+    "n8nNodesApiVersion": 1,
+    "nodes": [
+      "dist/nodes/YouTubeTranscript/YouTubeTranscript.node.js"
+    ]
+  },
+  "devDependencies": {
+    "@types/node": "^22.0.0",
+    "eslint": "^8.57.0",
+    "gulp": "^4.0.2",
+    "n8n-workflow": "^1.0.0",
+    "prettier": "^3.2.5",
+    "typescript": "~5.4.0"
+  },
+  "dependencies": {
+    "youtube-transcript": "^1.2.1"
+  },
+  "peerDependencies": {
+    "n8n-workflow": "*"
+  }
+}