mirror of
https://github.com/n8n-io/n8n.git
synced 2024-12-30 15:07:28 -08:00
609 lines
12 KiB
TypeScript
609 lines
12 KiB
TypeScript
import {
|
|
BINARY_ENCODING,
|
|
IExecuteFunctions,
|
|
} from 'n8n-core';
|
|
|
|
import {
|
|
IBinaryKeyData,
|
|
IDataObject,
|
|
ILoadOptionsFunctions,
|
|
INodeExecutionData,
|
|
INodePropertyOptions,
|
|
INodeType,
|
|
INodeTypeDescription,
|
|
} from 'n8n-workflow';
|
|
|
|
import {
|
|
pushbulletApiRequest,
|
|
pushbulletApiRequestAllItems,
|
|
} from './GenericFunctions';
|
|
|
|
import * as moment from 'moment-timezone';
|
|
|
|
export class Pushbullet implements INodeType {
|
|
description: INodeTypeDescription = {
|
|
displayName: 'Pushbullet',
|
|
name: 'pushbullet',
|
|
icon: 'file:pushbullet.svg',
|
|
group: ['input'],
|
|
version: 1,
|
|
subtitle: '={{$parameter["operation"] + ": " + $parameter["resource"]}}',
|
|
description: 'Consume Pushbullet API.',
|
|
defaults: {
|
|
name: 'Pushbullet',
|
|
color: '#457854',
|
|
},
|
|
inputs: ['main'],
|
|
outputs: ['main'],
|
|
credentials: [
|
|
{
|
|
name: 'pushbulletOAuth2Api',
|
|
required: true,
|
|
},
|
|
],
|
|
properties: [
|
|
{
|
|
displayName: 'Resource',
|
|
name: 'resource',
|
|
type: 'options',
|
|
options: [
|
|
{
|
|
name: 'Push',
|
|
value: 'push',
|
|
},
|
|
],
|
|
default: 'push',
|
|
description: 'The resource to operate on.',
|
|
},
|
|
{
|
|
displayName: 'Operation',
|
|
name: 'operation',
|
|
type: 'options',
|
|
displayOptions: {
|
|
show: {
|
|
resource: [
|
|
'push',
|
|
],
|
|
},
|
|
},
|
|
options: [
|
|
{
|
|
name: 'Create',
|
|
value: 'create',
|
|
description: 'Create a push',
|
|
},
|
|
{
|
|
name: 'Delete',
|
|
value: 'delete',
|
|
description: 'Delete a push',
|
|
},
|
|
{
|
|
name: 'Get All',
|
|
value: 'getAll',
|
|
description: 'Get all pushes',
|
|
},
|
|
{
|
|
name: 'Update',
|
|
value: 'update',
|
|
description: 'Update a push',
|
|
},
|
|
],
|
|
default: 'create',
|
|
description: 'The operation to perform.',
|
|
},
|
|
{
|
|
displayName: 'Type',
|
|
name: 'type',
|
|
type: 'options',
|
|
options: [
|
|
{
|
|
name: 'File',
|
|
value: 'file',
|
|
},
|
|
{
|
|
name: 'Link',
|
|
value: 'link',
|
|
},
|
|
{
|
|
name: 'Note',
|
|
value: 'note',
|
|
},
|
|
],
|
|
required: true,
|
|
displayOptions: {
|
|
show: {
|
|
resource: [
|
|
'push',
|
|
],
|
|
operation: [
|
|
'create',
|
|
],
|
|
},
|
|
},
|
|
default: 'note',
|
|
},
|
|
{
|
|
displayName: 'Title',
|
|
name: 'title',
|
|
type: 'string',
|
|
required: true,
|
|
displayOptions: {
|
|
show: {
|
|
resource: [
|
|
'push',
|
|
],
|
|
operation: [
|
|
'create',
|
|
],
|
|
type: [
|
|
'note',
|
|
'link',
|
|
],
|
|
},
|
|
},
|
|
default: '',
|
|
description: `Title of the push.`,
|
|
},
|
|
{
|
|
displayName: 'Body',
|
|
name: 'body',
|
|
type: 'string',
|
|
required: true,
|
|
displayOptions: {
|
|
show: {
|
|
resource: [
|
|
'push',
|
|
],
|
|
operation: [
|
|
'create',
|
|
],
|
|
type: [
|
|
'note',
|
|
'link',
|
|
'file',
|
|
],
|
|
},
|
|
},
|
|
default: '',
|
|
description: `Body of the push.`,
|
|
},
|
|
{
|
|
displayName: 'URL',
|
|
name: 'url',
|
|
type: 'string',
|
|
required: true,
|
|
displayOptions: {
|
|
show: {
|
|
resource: [
|
|
'push',
|
|
],
|
|
operation: [
|
|
'create',
|
|
],
|
|
type: [
|
|
'link',
|
|
],
|
|
},
|
|
},
|
|
default: '',
|
|
description: `URL of the push.`,
|
|
},
|
|
{
|
|
displayName: 'Binary Property',
|
|
name: 'binaryPropertyName',
|
|
type: 'string',
|
|
default: 'data',
|
|
required: true,
|
|
displayOptions: {
|
|
show: {
|
|
resource: [
|
|
'push',
|
|
],
|
|
operation: [
|
|
'create',
|
|
],
|
|
type: [
|
|
'file',
|
|
],
|
|
},
|
|
},
|
|
placeholder: '',
|
|
description: 'Name of the binary property which contains<br />the data for the file to be created.',
|
|
},
|
|
{
|
|
displayName: 'Target',
|
|
name: 'target',
|
|
type: 'options',
|
|
options: [
|
|
{
|
|
name: 'Channel Tag',
|
|
value: 'channel_tag',
|
|
description: 'Send the push to all subscribers to your channel that has this tag',
|
|
},
|
|
{
|
|
name: 'Default',
|
|
value: 'default',
|
|
description: `Broadcast it to all of the user's devices`,
|
|
},
|
|
{
|
|
name: 'Device ID',
|
|
value: 'device_iden',
|
|
description: 'Send the push to a specific device',
|
|
},
|
|
{
|
|
name: 'Email',
|
|
value: 'email',
|
|
description: 'Send the push to this email address',
|
|
},
|
|
],
|
|
required: true,
|
|
displayOptions: {
|
|
show: {
|
|
resource: [
|
|
'push',
|
|
],
|
|
operation: [
|
|
'create',
|
|
],
|
|
},
|
|
},
|
|
default: 'default',
|
|
description: 'Define the medium that will be used to send the push.',
|
|
},
|
|
{
|
|
displayName: 'Value',
|
|
name: 'value',
|
|
type: 'string',
|
|
required: true,
|
|
displayOptions: {
|
|
show: {
|
|
resource: [
|
|
'push',
|
|
],
|
|
operation: [
|
|
'create',
|
|
],
|
|
},
|
|
hide: {
|
|
target: [
|
|
'default',
|
|
'device_iden',
|
|
],
|
|
},
|
|
},
|
|
default: '',
|
|
description: `The value to be set depending on the target selected.<br>
|
|
For example, if the target selected is email then this field would take the email address<br>
|
|
of the person you are trying to send the push to.`,
|
|
},
|
|
{
|
|
displayName: 'Value',
|
|
name: 'value',
|
|
type: 'options',
|
|
typeOptions: {
|
|
loadOptionsMethod: 'getDevices',
|
|
},
|
|
required: true,
|
|
displayOptions: {
|
|
show: {
|
|
resource: [
|
|
'push',
|
|
],
|
|
operation: [
|
|
'create',
|
|
],
|
|
target: [
|
|
'device_iden',
|
|
],
|
|
},
|
|
},
|
|
default: '',
|
|
description: '',
|
|
},
|
|
{
|
|
displayName: 'Push ID',
|
|
name: 'pushId',
|
|
type: 'string',
|
|
required: true,
|
|
displayOptions: {
|
|
show: {
|
|
resource: [
|
|
'push',
|
|
],
|
|
operation: [
|
|
'delete',
|
|
],
|
|
},
|
|
},
|
|
default: '',
|
|
},
|
|
{
|
|
displayName: 'Return All',
|
|
name: 'returnAll',
|
|
type: 'boolean',
|
|
displayOptions: {
|
|
show: {
|
|
operation: [
|
|
'getAll',
|
|
],
|
|
resource: [
|
|
'push',
|
|
],
|
|
},
|
|
},
|
|
default: false,
|
|
description: 'If all results should be returned or only up to a given limit.',
|
|
},
|
|
{
|
|
displayName: 'Limit',
|
|
name: 'limit',
|
|
type: 'number',
|
|
displayOptions: {
|
|
show: {
|
|
operation: [
|
|
'getAll',
|
|
],
|
|
resource: [
|
|
'push',
|
|
],
|
|
returnAll: [
|
|
false,
|
|
],
|
|
},
|
|
},
|
|
typeOptions: {
|
|
minValue: 1,
|
|
maxValue: 500,
|
|
},
|
|
default: 100,
|
|
description: 'How many results to return.',
|
|
},
|
|
{
|
|
displayName: 'Filters',
|
|
name: 'filters',
|
|
type: 'collection',
|
|
placeholder: 'Add Filter',
|
|
default: {},
|
|
displayOptions: {
|
|
show: {
|
|
resource: [
|
|
'push',
|
|
],
|
|
operation: [
|
|
'getAll',
|
|
],
|
|
},
|
|
},
|
|
options: [
|
|
{
|
|
displayName: 'Active',
|
|
name: 'active',
|
|
type: 'boolean',
|
|
default: false,
|
|
description: `Don't return deleted pushes.`,
|
|
},
|
|
{
|
|
displayName: 'Modified After',
|
|
name: 'modified_after',
|
|
type: 'dateTime',
|
|
default: '',
|
|
description: `Request pushes modified after this timestamp.`,
|
|
},
|
|
],
|
|
},
|
|
{
|
|
displayName: 'Push ID',
|
|
name: 'pushId',
|
|
type: 'string',
|
|
required: true,
|
|
displayOptions: {
|
|
show: {
|
|
resource: [
|
|
'push',
|
|
],
|
|
operation: [
|
|
'update',
|
|
],
|
|
},
|
|
},
|
|
default: '',
|
|
},
|
|
{
|
|
displayName: 'Dismissed',
|
|
name: 'dismissed',
|
|
type: 'boolean',
|
|
required: true,
|
|
displayOptions: {
|
|
show: {
|
|
resource: [
|
|
'push',
|
|
],
|
|
operation: [
|
|
'update',
|
|
],
|
|
},
|
|
},
|
|
default: false,
|
|
description: 'Marks a push as having been dismissed by the user, will cause any notifications for the push to be hidden if possible.',
|
|
},
|
|
],
|
|
};
|
|
|
|
methods = {
|
|
loadOptions: {
|
|
async getDevices(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]> {
|
|
const returnData: INodePropertyOptions[] = [];
|
|
const { devices } = await pushbulletApiRequest.call(this, 'GET', '/devices');
|
|
for (const device of devices) {
|
|
returnData.push({
|
|
name: device.nickname,
|
|
value: device.iden,
|
|
});
|
|
}
|
|
return returnData;
|
|
},
|
|
},
|
|
};
|
|
|
|
|
|
async execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]> {
|
|
const items = this.getInputData();
|
|
const returnData: IDataObject[] = [];
|
|
const length = (items.length as unknown) as number;
|
|
const qs: IDataObject = {};
|
|
let responseData;
|
|
const resource = this.getNodeParameter('resource', 0) as string;
|
|
const operation = this.getNodeParameter('operation', 0) as string;
|
|
for (let i = 0; i < length; i++) {
|
|
|
|
if (resource === 'push') {
|
|
if (operation === 'create') {
|
|
const type = this.getNodeParameter('type', i) as string;
|
|
|
|
const message = this.getNodeParameter('body', i) as string;
|
|
|
|
const target = this.getNodeParameter('target', i) as string;
|
|
|
|
const body: IDataObject = {
|
|
type,
|
|
body: message,
|
|
};
|
|
|
|
if (target !== 'default') {
|
|
const value = this.getNodeParameter('value', i) as string;
|
|
body[target as string] = value;
|
|
}
|
|
|
|
if (['note', 'link'].includes(type)) {
|
|
body.title = this.getNodeParameter('title', i) as string;
|
|
|
|
if (type === 'link') {
|
|
body.url = this.getNodeParameter('url', i) as string;
|
|
}
|
|
}
|
|
|
|
if (type === 'file') {
|
|
const binaryPropertyName = this.getNodeParameter('binaryPropertyName', 0) as string;
|
|
|
|
if (items[i].binary === undefined) {
|
|
throw new Error('No binary data exists on item!');
|
|
}
|
|
//@ts-ignore
|
|
if (items[i].binary[binaryPropertyName] === undefined) {
|
|
throw new Error(`No binary data property "${binaryPropertyName}" does not exists on item!`);
|
|
}
|
|
|
|
const binaryData = (items[i].binary as IBinaryKeyData)[binaryPropertyName];
|
|
|
|
//create upload url
|
|
const {
|
|
upload_url: uploadUrl,
|
|
file_name,
|
|
file_type,
|
|
file_url,
|
|
} = await pushbulletApiRequest.call(
|
|
this,
|
|
'POST',
|
|
`/upload-request`,
|
|
{
|
|
file_name: binaryData.fileName,
|
|
file_type: binaryData.mimeType,
|
|
},
|
|
);
|
|
|
|
//upload the file
|
|
await pushbulletApiRequest.call(
|
|
this,
|
|
'POST',
|
|
'',
|
|
{},
|
|
{},
|
|
uploadUrl,
|
|
{
|
|
formData: {
|
|
file: {
|
|
value: Buffer.from(binaryData.data, BINARY_ENCODING),
|
|
options: {
|
|
filename: binaryData.fileName,
|
|
},
|
|
},
|
|
},
|
|
json: false,
|
|
},
|
|
);
|
|
|
|
body.file_name = file_name;
|
|
body.file_type = file_type;
|
|
body.file_url = file_url;
|
|
}
|
|
|
|
responseData = await pushbulletApiRequest.call(
|
|
this,
|
|
'POST',
|
|
`/pushes`,
|
|
body,
|
|
);
|
|
}
|
|
|
|
if (operation === 'getAll') {
|
|
const returnAll = this.getNodeParameter('returnAll', 0) as boolean;
|
|
|
|
const filters = this.getNodeParameter('filters', i) as IDataObject;
|
|
|
|
Object.assign(qs, filters);
|
|
|
|
if (qs.modified_after) {
|
|
qs.modified_after = moment(qs.modified_after as string).unix();
|
|
}
|
|
|
|
if (returnAll) {
|
|
responseData = await pushbulletApiRequestAllItems.call(this, 'pushes', 'GET', '/pushes', {}, qs);
|
|
|
|
} else {
|
|
qs.limit = this.getNodeParameter('limit', 0) as number;
|
|
|
|
responseData = await pushbulletApiRequest.call(this, 'GET', '/pushes', {}, qs);
|
|
|
|
responseData = responseData.pushes;
|
|
}
|
|
}
|
|
|
|
if (operation === 'delete') {
|
|
const pushId = this.getNodeParameter('pushId', i) as string;
|
|
|
|
responseData = await pushbulletApiRequest.call(
|
|
this,
|
|
'DELETE',
|
|
`/pushes/${pushId}`,
|
|
);
|
|
|
|
responseData = { success: true };
|
|
}
|
|
|
|
if (operation === 'update') {
|
|
const pushId = this.getNodeParameter('pushId', i) as string;
|
|
|
|
const dismissed = this.getNodeParameter('dismissed', i) as boolean;
|
|
|
|
responseData = await pushbulletApiRequest.call(
|
|
this,
|
|
'POST',
|
|
`/pushes/${pushId}`,
|
|
{
|
|
dismissed,
|
|
},
|
|
);
|
|
}
|
|
}
|
|
}
|
|
if (Array.isArray(responseData)) {
|
|
returnData.push.apply(returnData, responseData as IDataObject[]);
|
|
|
|
} else if (responseData !== undefined) {
|
|
returnData.push(responseData as IDataObject);
|
|
|
|
}
|
|
return [this.helpers.returnJsonArray(returnData)];
|
|
}
|
|
}
|