n8n-nodes-zapcap 1.0.0

package/README.md

@@ -0,0 +1,78 @@
+# n8n-nodes-zapcap
+
+This is an n8n community node that integrates with the [Zapcap.ai](https://zapcap.ai/) REST API. It allows you to programmatically add animated, styled subtitles to videos and automatically slice viral clips/shorts from long-form content.
+
+## Features
+
+- **Video Management**: Direct upload of local video files or URL-based uploads.
+- **Templates**: Fetch designer templates directly.
+- **Tasks**: Create video rendering and captioning tasks with customizable parameters (language, auto-approve, template, and advanced style properties).
+- **Transcript Editing**: Retrieve and edit transcription text/timestamps before triggering rendering.
+- **AI Clipping**: Automatically cut engaging viral shorts from longer videos with specific target durations.
+
+---
+
+## Installation
+
+### Community Nodes (n8n Web UI)
+If this package is published on npm, you can install it via the n8n interface:
+1. Go to **Settings** > **Community Nodes**.
+2. Click **Install a new node**.
+3. Enter `n8n-nodes-zapcap` and click **Install**.
+
+### Manual Installation (Local Development)
+For local testing or offline deployment:
+1. Clone or copy this directory to your machine.
+2. Build the project:
+   ```bash
+   npm install
+   npm run build
+   ```
+3. Copy the compiled files into your local n8n custom directory:
+   - **Windows**: Copy the entire directory or link it inside `%USERPROFILE%\.n8n\custom\`
+   - **Linux / macOS**: Copy or link inside `~/.n8n/custom/`
+4. Restart your n8n instance.
+
+---
+
+## Configuration & Credentials
+
+To use the Zapcap node, you must set up a **Zapcap API** credential:
+1. Go to the [ZapCap Dashboard API Key page](https://platform.zapcap.ai/dashboard/api-key) and copy your API Key.
+2. In n8n, create a new Credential of type **Zapcap API**.
+3. Paste your **API Key** into the credential field.
+
+---
+
+## Operations Overview
+
+### Video
+- **Upload File**: Upload a local video from a previous node's binary data (form-data upload).
+- **Upload via URL**: Send a public URL of a remote video file (e.g. from S3, Google Drive, etc.).
+- **Get All Tasks**: Retrieve a list of all render tasks or clip tasks associated with a video.
+
+### Task
+- **Create**: Initialize subtitle transcription and rendering. You can specify:
+  - `templateId` (Style Template)
+  - `language` (48 supported languages)
+  - `autoApprove` (Set to `false` if you want to edit transcripts before rendering)
+  - `renderOptions` (JSON schema for fonts, colors, emoji inclusion, etc.)
+- **Get Status**: Retrieve status of rendering (`pending`, `transcribing`, `rendering`, `completed`, `failed`).
+
+### Transcript
+- **Get**: Fetch the JSON array of words, start/end timestamps.
+- **Update**: Commit transcript edits (useful for correcting names/jargon before rendering).
+- **Approve**: Approve a transcript manually to trigger video rendering (if `autoApprove` was set to false).
+
+### Clipping (Viral Shorts)
+- **Create Clipping Task**: Extract 1-5 engaging viral clips. Specify the desired duration range (e.g., `< 30s`, `30-60s`).
+- **Get Status**: Check completion and retrieve direct download URLs and generated themes for each clip.
+
+### Template
+- **Get All**: Return list of all designer subtitle templates available to your account.
+
+---
+
+## License
+
+[MIT](LICENSE)

package/credentials/ZapcapApi.credentials.ts

@@ -0,0 +1,23 @@
+import {
+	ICredentialType,
+	INodeProperties,
+} from 'n8n-workflow';
+
+export class ZapcapApi implements ICredentialType {
+	name = 'zapcapApi';
+	displayName = 'Zapcap API';
+	documentationUrl = 'https://platform.zapcap.ai/docs/';
+	properties: INodeProperties[] = [
+		{
+			displayName: 'API Key',
+			name: 'apiKey',
+			type: 'string',
+			typeOptions: {
+				password: true,
+			},
+			default: '',
+			required: true,
+			description: 'The API Key to authenticate with Zapcap (obtain from platform.zapcap.ai)',
+		},
+	];
+}

package/dist/credentials/ZapcapApi.credentials.d.ts

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

package/dist/credentials/ZapcapApi.credentials.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ZapcapApi = void 0;
+class ZapcapApi {
+    constructor() {
+        this.name = 'zapcapApi';
+        this.displayName = 'Zapcap API';
+        this.documentationUrl = 'https://platform.zapcap.ai/docs/';
+        this.properties = [
+            {
+                displayName: 'API Key',
+                name: 'apiKey',
+                type: 'string',
+                typeOptions: {
+                    password: true,
+                },
+                default: '',
+                required: true,
+                description: 'The API Key to authenticate with Zapcap (obtain from platform.zapcap.ai)',
+            },
+        ];
+    }
+}
+exports.ZapcapApi = ZapcapApi;

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

@@ -0,0 +1,3 @@
+import { IExecuteFunctions, IHookFunctions, ILoadOptionsFunctions, IBinaryData } from 'n8n-workflow';
+export declare function zapcapApiRequest(this: IExecuteFunctions | IHookFunctions | ILoadOptionsFunctions, method: string, resource: string, body?: any, qs?: any, uri?: string, option?: any): Promise<any>;
+export declare function zapcapApiUploadRequest(this: IExecuteFunctions, binaryData: IBinaryData, binaryBuffer: Buffer): Promise<any>;

package/dist/nodes/Zapcap/GenericFunctions.js

@@ -0,0 +1,68 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.zapcapApiRequest = zapcapApiRequest;
+exports.zapcapApiUploadRequest = zapcapApiUploadRequest;
+async function zapcapApiRequest(method, resource, body = {}, qs = {}, uri, option = {}) {
+    const credentials = await this.getCredentials('zapcapApi');
+    if (credentials === undefined) {
+        throw new Error('No credentials configured!');
+    }
+    const baseUrl = 'https://api.zapcap.ai';
+    const endpoint = uri || `${baseUrl}${resource}`;
+    const options = {
+        headers: {
+            'x-api-key': credentials.apiKey,
+            Accept: 'application/json',
+        },
+        method,
+        uri: endpoint,
+        qs,
+        json: true,
+        ...option,
+    };
+    if (Object.keys(body).length > 0) {
+        options.body = body;
+    }
+    try {
+        return await this.helpers.request(options);
+    }
+    catch (error) {
+        throw new Error(`Zapcap API error: ${error.message || error}`);
+    }
+}
+async function zapcapApiUploadRequest(binaryData, binaryBuffer) {
+    const credentials = await this.getCredentials('zapcapApi');
+    if (credentials === undefined) {
+        throw new Error('No credentials configured!');
+    }
+    const boundary = `----n8nFormBoundary${Date.now()}`;
+    const fileName = binaryData.fileName || 'video.mp4';
+    const mimeType = binaryData.mimeType || 'video/mp4';
+    const preamble = `--${boundary}\r\n` +
+        `Content-Disposition: form-data; name="file"; filename="${fileName}"\r\n` +
+        `Content-Type: ${mimeType}\r\n\r\n`;
+    const closing = `\r\n--${boundary}--\r\n`;
+    const bodyBuffer = Buffer.concat([
+        Buffer.from(preamble, 'utf8'),
+        binaryBuffer,
+        Buffer.from(closing, 'utf8'),
+    ]);
+    const options = {
+        headers: {
+            'x-api-key': credentials.apiKey,
+            'Content-Type': `multipart/form-data; boundary=${boundary}`,
+            'Content-Length': bodyBuffer.length.toString(),
+            Accept: 'application/json',
+        },
+        method: 'POST',
+        uri: 'https://api.zapcap.ai/videos',
+        body: bodyBuffer,
+        json: true,
+    };
+    try {
+        return await this.helpers.request(options);
+    }
+    catch (error) {
+        throw new Error(`Zapcap Upload API error: ${error.message || error}`);
+    }
+}

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

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

package/dist/nodes/Zapcap/Zapcap.node.js

@@ -0,0 +1,144 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Zapcap = void 0;
+const ZapcapDescription_1 = require("./ZapcapDescription");
+const GenericFunctions_1 = require("./GenericFunctions");
+class Zapcap {
+    constructor() {
+        this.description = {
+            displayName: 'Zapcap',
+            name: 'zapcap',
+            icon: 'file:icon.svg',
+            group: ['transform'],
+            version: 1,
+            subtitle: '={{$parameter["resource"] + ": " + $parameter["operation"]}}',
+            description: 'Automated video captioning and editing using Zapcap.ai API',
+            defaults: {
+                name: 'Zapcap',
+            },
+            inputs: ['main'],
+            outputs: ['main'],
+            credentials: [
+                {
+                    name: 'zapcapApi',
+                    required: true,
+                },
+            ],
+            properties: ZapcapDescription_1.zapcapNodeProperties,
+        };
+    }
+    async execute() {
+        const items = this.getInputData();
+        const returnData = [];
+        const resource = this.getNodeParameter('resource', 0);
+        const operation = this.getNodeParameter('operation', 0);
+        for (let i = 0; i < items.length; i++) {
+            try {
+                let responseData;
+                if (resource === 'video') {
+                    if (operation === 'upload') {
+                        const binaryPropertyName = this.getNodeParameter('binaryPropertyName', i);
+                        const binaryData = this.helpers.assertBinaryData(i, binaryPropertyName);
+                        const binaryBuffer = await this.helpers.getBinaryDataBuffer(i, binaryPropertyName);
+                        responseData = await GenericFunctions_1.zapcapApiUploadRequest.call(this, binaryData, binaryBuffer);
+                    }
+                    else if (operation === 'uploadUrl') {
+                        const url = this.getNodeParameter('videoUrl', i);
+                        responseData = await GenericFunctions_1.zapcapApiRequest.call(this, 'POST', '/videos/url', { url });
+                    }
+                    else if (operation === 'getAllTasks') {
+                        const videoId = this.getNodeParameter('videoId', i);
+                        responseData = await GenericFunctions_1.zapcapApiRequest.call(this, 'GET', `/videos/${videoId}/tasks`);
+                    }
+                }
+                else if (resource === 'task') {
+                    if (operation === 'create') {
+                        const videoId = this.getNodeParameter('videoId', i);
+                        const templateId = this.getNodeParameter('templateId', i);
+                        const language = this.getNodeParameter('language', i);
+                        const autoApprove = this.getNodeParameter('autoApprove', i);
+                        const additionalFields = this.getNodeParameter('additionalFields', i);
+                        const body = {
+                            templateId,
+                            language,
+                            autoApprove,
+                        };
+                        if (additionalFields.transcriptTaskId) {
+                            body.transcriptTaskId = additionalFields.transcriptTaskId;
+                        }
+                        if (additionalFields.renderOptionsJson) {
+                            try {
+                                body.renderOptions = typeof additionalFields.renderOptionsJson === 'string'
+                                    ? JSON.parse(additionalFields.renderOptionsJson)
+                                    : additionalFields.renderOptionsJson;
+                            }
+                            catch (err) {
+                                throw new Error('Render Options JSON is invalid: ' + err.message);
+                            }
+                        }
+                        responseData = await GenericFunctions_1.zapcapApiRequest.call(this, 'POST', `/videos/${videoId}/task`, body);
+                    }
+                    else if (operation === 'get') {
+                        const videoId = this.getNodeParameter('videoId', i);
+                        const taskId = this.getNodeParameter('taskId', i);
+                        responseData = await GenericFunctions_1.zapcapApiRequest.call(this, 'GET', `/videos/${videoId}/task/${taskId}`);
+                    }
+                }
+                else if (resource === 'transcript') {
+                    const videoId = this.getNodeParameter('videoId', i);
+                    const taskId = this.getNodeParameter('taskId', i);
+                    if (operation === 'get') {
+                        responseData = await GenericFunctions_1.zapcapApiRequest.call(this, 'GET', `/videos/${videoId}/task/${taskId}/transcript`);
+                    }
+                    else if (operation === 'update') {
+                        const transcriptJson = this.getNodeParameter('transcriptJson', i);
+                        const body = typeof transcriptJson === 'string' ? JSON.parse(transcriptJson) : transcriptJson;
+                        responseData = await GenericFunctions_1.zapcapApiRequest.call(this, 'PUT', `/videos/${videoId}/task/${taskId}/transcript`, body);
+                    }
+                    else if (operation === 'approve') {
+                        responseData = await GenericFunctions_1.zapcapApiRequest.call(this, 'POST', `/videos/${videoId}/task/${taskId}/approve-transcript`);
+                    }
+                }
+                else if (resource === 'clipping') {
+                    const videoId = this.getNodeParameter('videoId', i);
+                    if (operation === 'create') {
+                        const maxClips = this.getNodeParameter('maxClips', i);
+                        const durationRange = this.getNodeParameter('durationRange', i);
+                        const body = {
+                            maxClips,
+                            durationRange,
+                        };
+                        responseData = await GenericFunctions_1.zapcapApiRequest.call(this, 'POST', `/videos/${videoId}/clipTask`, body);
+                    }
+                    else if (operation === 'get') {
+                        const clipTaskId = this.getNodeParameter('clipTaskId', i);
+                        responseData = await GenericFunctions_1.zapcapApiRequest.call(this, 'GET', `/videos/${videoId}/clipTask/${clipTaskId}`);
+                    }
+                }
+                else if (resource === 'template') {
+                    if (operation === 'getAll') {
+                        responseData = await GenericFunctions_1.zapcapApiRequest.call(this, 'GET', '/templates');
+                    }
+                }
+                if (Array.isArray(responseData)) {
+                    const executionData = this.helpers.returnJsonArray(responseData);
+                    returnData.push(...executionData);
+                }
+                else {
+                    const executionData = this.helpers.returnJsonArray([responseData]);
+                    returnData.push(...executionData);
+                }
+            }
+            catch (error) {
+                if (this.continueOnFail()) {
+                    returnData.push({ json: { error: error.message } });
+                }
+                else {
+                    throw error;
+                }
+            }
+        }
+        return [returnData];
+    }
+}
+exports.Zapcap = Zapcap;

package/dist/nodes/Zapcap/ZapcapDescription.d.ts

@@ -0,0 +1,2 @@
+import { INodeProperties } from 'n8n-workflow';
+export declare const zapcapNodeProperties: INodeProperties[];