n8n-nodes-base
Version:
Base nodes of n8n
254 lines • 11.3 kB
JavaScript
;
Object.defineProperty(exports, "__esModule", { value: true });
exports.LocalFileTrigger = void 0;
const chokidar_1 = require("chokidar");
const n8n_workflow_1 = require("n8n-workflow");
class LocalFileTrigger {
description = {
displayName: 'Local File Trigger',
name: 'localFileTrigger',
icon: 'fa:folder-open',
iconColor: 'black',
group: ['trigger'],
version: 1,
subtitle: '=Path: {{$parameter["path"]}}',
description: 'Triggers a workflow on file system changes',
eventTriggerDescription: '',
defaults: {
name: 'Local File Trigger',
color: '#404040',
},
triggerPanel: {
header: '',
executionsHelp: {
inactive: "<b>While building your workflow</b>, click the 'execute step' button, then make a change to your watched file or folder. This will trigger an execution, which will show up in this editor.<br /> <br /><b>Once you're happy with your workflow</b>, publish it. Then every time a change is detected, the workflow will execute. These executions will show up in the <a data-key='executions'>executions list</a>, but not in the editor.",
active: "<b>While building your workflow</b>, click the 'execute step' button, then make a change to your watched file or folder. This will trigger an execution, which will show up in this editor.<br /> <br /><b>Your workflow will also execute automatically</b>, since it's activated. Every time a change is detected, this node will trigger an execution. These executions will show up in the <a data-key='executions'>executions list</a>, but not in the editor.",
},
activationHint: 'Once you’ve finished building your workflow, publish it to have it also listen continuously (you just won’t see those executions here).',
},
inputs: [],
outputs: [n8n_workflow_1.NodeConnectionTypes.Main],
properties: [
{
displayName: 'Trigger On',
name: 'triggerOn',
type: 'options',
options: [
{
name: 'Changes to a Specific File',
value: 'file',
},
{
name: 'Changes Involving a Specific Folder',
value: 'folder',
},
],
required: true,
default: '',
},
{
displayName: 'File to Watch',
name: 'path',
type: 'string',
displayOptions: {
show: {
triggerOn: ['file'],
},
},
default: '',
placeholder: '/data/invoices/1.pdf',
},
{
displayName: 'Folder to Watch',
name: 'path',
type: 'string',
displayOptions: {
show: {
triggerOn: ['folder'],
},
},
default: '',
placeholder: '/data/invoices',
},
{
displayName: 'Watch for',
name: 'events',
type: 'multiOptions',
displayOptions: {
show: {
triggerOn: ['folder'],
},
},
options: [
{
name: 'File Added',
value: 'add',
description: 'Triggers whenever a new file was added',
},
{
name: 'File Changed',
value: 'change',
description: 'Triggers whenever a file was changed',
},
{
name: 'File Deleted',
value: 'unlink',
description: 'Triggers whenever a file was deleted',
},
{
name: 'Folder Added',
value: 'addDir',
description: 'Triggers whenever a new folder was added',
},
{
name: 'Folder Deleted',
value: 'unlinkDir',
description: 'Triggers whenever a folder was deleted',
},
],
required: true,
default: [],
description: 'The events to listen to',
},
{
displayName: 'Options',
name: 'options',
type: 'collection',
placeholder: 'Add option',
default: {},
options: [
{
displayName: 'Await Write Finish',
name: 'awaitWriteFinish',
type: 'boolean',
default: false,
description: 'Whether to wait until files finished writing to avoid partially read',
},
{
displayName: 'Include Linked Files/Folders',
name: 'followSymlinks',
type: 'boolean',
default: true,
description: 'Whether linked files/folders will also be watched (this includes symlinks, aliases on MacOS and shortcuts on Windows). Otherwise only the links themselves will be monitored).',
},
{
displayName: 'Ignore',
name: 'ignored',
type: 'string',
default: '',
placeholder: '**/*.txt or ignore-me/subfolder',
description: "Files or paths to ignore. The whole path is tested, not just the filename. Supports <a href=\"https://github.com/micromatch/anymatch\">Anymatch</a>- syntax. Regex patterns may not work on macOS. To ignore files based on substring matching, use the 'Ignore Mode' option with 'Contain'.",
},
{
displayName: 'Ignore Existing Files/Folders',
name: 'ignoreInitial',
type: 'boolean',
default: true,
description: 'Whether to ignore existing files/folders to not trigger an event',
},
{
displayName: 'Max Folder Depth',
name: 'depth',
type: 'options',
options: [
{
name: '1 Levels Down',
value: 1,
},
{
name: '2 Levels Down',
value: 2,
},
{
name: '3 Levels Down',
value: 3,
},
{
name: '4 Levels Down',
value: 4,
},
{
name: '5 Levels Down',
value: 5,
},
{
name: 'Top Folder Only',
value: 0,
},
{
name: 'Unlimited',
value: -1,
},
],
default: -1,
description: 'How deep into the folder structure to watch for changes',
},
{
displayName: 'Use Polling',
name: 'usePolling',
type: 'boolean',
default: false,
description: 'Whether to use polling for watching. Typically necessary to successfully watch files over a network.',
},
{
displayName: 'Ignore Mode',
name: 'ignoreMode',
type: 'options',
options: [
{
name: 'Match',
value: 'match',
description: 'Ignore files using regex patterns (e.g., **/*.txt), Not supported on macOS',
},
{
name: 'Contain',
value: 'contain',
description: 'Ignore files if their path contains the specified value',
},
],
default: 'match',
description: 'Whether to ignore files using regex matching (Anymatch patterns) or by checking if the path contains a specified value',
},
],
},
],
};
async trigger() {
const triggerOn = this.getNodeParameter('triggerOn');
const path = this.getNodeParameter('path');
const options = this.getNodeParameter('options', {});
let events;
if (triggerOn === 'file') {
events = ['change'];
}
else {
events = this.getNodeParameter('events', []);
}
const ignored = options.ignored === '' ? undefined : options.ignored;
const watcher = (0, chokidar_1.watch)(path, {
ignored: options.ignoreMode === 'match' ? ignored : (x) => x.includes(ignored),
persistent: true,
ignoreInitial: options.ignoreInitial === undefined ? true : options.ignoreInitial,
followSymlinks: options.followSymlinks === undefined ? true : options.followSymlinks,
depth: [-1, undefined].includes(options.depth)
? undefined
: options.depth,
usePolling: options.usePolling,
awaitWriteFinish: options.awaitWriteFinish,
});
const executeTrigger = (event, pathString) => {
this.emit([this.helpers.returnJsonArray([{ event, path: pathString }])]);
};
for (const eventName of events) {
watcher.on(eventName, (pathString) => executeTrigger(eventName, pathString));
}
async function closeFunction() {
return await watcher.close();
}
return {
closeFunction,
};
}
}
exports.LocalFileTrigger = LocalFileTrigger;
//# sourceMappingURL=LocalFileTrigger.node.js.map