n8n/packages/nodes-base/nodes/Beeminder/Beeminder.node.ts
कारतोफ्फेलस्क्रिप्ट™ 6aa7b93473
refactor(core): Deprecate prepareOutputData (no-changelog) (#7091)
2023-09-05 12:59:02 +02:00

385 lines
9.3 KiB
TypeScript

import type {
IExecuteFunctions,
IDataObject,
ILoadOptionsFunctions,
INodeExecutionData,
INodeParameters,
INodePropertyOptions,
INodeType,
INodeTypeDescription,
} from 'n8n-workflow';
import {
createDatapoint,
deleteDatapoint,
getAllDatapoints,
updateDatapoint,
} from './Beeminder.node.functions';
import { beeminderApiRequest } from './GenericFunctions';
import moment from 'moment-timezone';
export class Beeminder implements INodeType {
description: INodeTypeDescription = {
displayName: 'Beeminder',
name: 'beeminder',
group: ['output'],
version: 1,
description: 'Consume Beeminder API',
subtitle: '={{$parameter["operation"] + ": " + $parameter["resource"]}}',
defaults: {
name: 'Beeminder',
},
// eslint-disable-next-line n8n-nodes-base/node-class-description-icon-not-svg
icon: 'file:beeminder.png',
inputs: ['main'],
outputs: ['main'],
credentials: [
{
name: 'beeminderApi',
required: true,
},
],
properties: [
{
displayName: 'Resource',
name: 'resource',
type: 'options',
noDataExpression: true,
required: true,
options: [
{
name: 'Datapoint',
value: 'datapoint',
},
],
default: 'datapoint',
},
{
displayName: 'Operation',
name: 'operation',
type: 'options',
noDataExpression: true,
options: [
{
name: 'Create',
value: 'create',
description: 'Create datapoint for goal',
action: 'Create datapoint for goal',
},
{
name: 'Delete',
value: 'delete',
description: 'Delete a datapoint',
action: 'Delete a datapoint',
},
{
name: 'Get Many',
value: 'getAll',
description: 'Get many datapoints for a goal',
action: 'Get many datapoints for a goal',
},
{
name: 'Update',
value: 'update',
description: 'Update a datapoint',
action: 'Update a datapoint',
},
],
default: 'create',
required: true,
},
{
displayName: 'Goal Name or ID',
name: 'goalName',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getGoals',
},
displayOptions: {
show: {
resource: ['datapoint'],
},
},
default: '',
description:
'The name of the goal. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>.',
required: true,
},
{
displayName: 'Return All',
name: 'returnAll',
type: 'boolean',
displayOptions: {
show: {
operation: ['getAll'],
resource: ['datapoint'],
},
},
default: false,
description: 'Whether to return all results or only up to a given limit',
},
{
displayName: 'Limit',
name: 'limit',
type: 'number',
displayOptions: {
show: {
operation: ['getAll'],
resource: ['datapoint'],
returnAll: [false],
},
},
typeOptions: {
minValue: 1,
maxValue: 300,
},
default: 30,
description: 'Max number of results to return',
},
{
displayName: 'Value',
name: 'value',
type: 'number',
default: 1,
placeholder: '',
description: 'Datapoint value to send',
displayOptions: {
show: {
resource: ['datapoint'],
operation: ['create'],
},
},
required: true,
},
{
displayName: 'Datapoint ID',
name: 'datapointId',
type: 'string',
default: '',
displayOptions: {
show: {
operation: ['update', 'delete'],
},
},
required: true,
},
{
displayName: 'Additional Fields',
name: 'additionalFields',
type: 'collection',
placeholder: 'Add Field',
default: {},
displayOptions: {
show: {
resource: ['datapoint'],
operation: ['create'],
},
},
options: [
{
displayName: 'Comment',
name: 'comment',
type: 'string',
default: '',
},
{
displayName: 'Timestamp',
name: 'timestamp',
type: 'dateTime',
default: '',
placeholder: '',
description:
'Defaults to "now" if none is passed in, or the existing timestamp if the datapoint is being updated rather than created',
},
{
displayName: 'Request ID',
name: 'requestid',
type: 'string',
default: '',
placeholder: '',
description: 'String to uniquely identify a datapoint',
},
],
},
{
displayName: 'Options',
name: 'options',
type: 'collection',
placeholder: 'Add field',
default: {},
displayOptions: {
show: {
resource: ['datapoint'],
operation: ['getAll'],
},
},
options: [
{
displayName: 'Sort',
name: 'sort',
type: 'string',
default: 'id',
placeholder: '',
description: 'Attribute to sort on',
},
],
},
{
displayName: 'Update Fields',
name: 'updateFields',
type: 'collection',
placeholder: 'Add Field',
default: {},
displayOptions: {
show: {
resource: ['datapoint'],
operation: ['update'],
},
},
options: [
{
displayName: 'Value',
name: 'value',
type: 'number',
default: 1,
placeholder: '',
description: 'Datapoint value to send',
},
{
displayName: 'Comment',
name: 'comment',
type: 'string',
default: '',
},
{
displayName: 'Timestamp',
name: 'timestamp',
type: 'dateTime',
default: '',
placeholder: '',
description:
'Defaults to "now" if none is passed in, or the existing timestamp if the datapoint is being updated rather than created',
},
],
},
],
};
methods = {
loadOptions: {
// Get all the available groups to display them to user so that they can
// select them easily
async getGoals(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]> {
const credentials = await this.getCredentials('beeminderApi');
const endpoint = `/users/${credentials.user}/goals.json`;
const returnData: INodePropertyOptions[] = [];
const goals = await beeminderApiRequest.call(this, 'GET', endpoint);
for (const goal of goals) {
returnData.push({
name: goal.slug,
value: goal.slug,
});
}
return returnData;
},
},
};
async execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]> {
const items = this.getInputData();
const returnData: INodeExecutionData[] = [];
const length = items.length;
const timezone = this.getTimezone();
const resource = this.getNodeParameter('resource', 0);
const operation = this.getNodeParameter('operation', 0);
let results;
for (let i = 0; i < length; i++) {
try {
if (resource === 'datapoint') {
const goalName = this.getNodeParameter('goalName', i) as string;
if (operation === 'create') {
const value = this.getNodeParameter('value', i) as number;
const options = this.getNodeParameter('additionalFields', i) as INodeParameters;
const data: IDataObject = {
value,
goalName,
};
Object.assign(data, options);
if (data.timestamp) {
data.timestamp = moment.tz(data.timestamp, timezone).unix();
}
results = await createDatapoint.call(this, data);
const executionData = this.helpers.constructExecutionMetaData(
this.helpers.returnJsonArray(results as IDataObject[]),
{ itemData: { item: i } },
);
returnData.push(...executionData);
} else if (operation === 'getAll') {
const returnAll = this.getNodeParameter('returnAll', i);
const options = this.getNodeParameter('options', i) as INodeParameters;
const data: IDataObject = {
goalName,
};
Object.assign(data, options);
if (!returnAll) {
data.count = this.getNodeParameter('limit', 0);
}
results = await getAllDatapoints.call(this, data);
const executionData = this.helpers.constructExecutionMetaData(
this.helpers.returnJsonArray(results as IDataObject[]),
{ itemData: { item: i } },
);
returnData.push(...executionData);
} else if (operation === 'update') {
const datapointId = this.getNodeParameter('datapointId', i) as string;
const options = this.getNodeParameter('updateFields', i) as INodeParameters;
const data: IDataObject = {
goalName,
datapointId,
};
Object.assign(data, options);
if (data.timestamp) {
data.timestamp = moment.tz(data.timestamp, timezone).unix();
}
results = await updateDatapoint.call(this, data);
const executionData = this.helpers.constructExecutionMetaData(
this.helpers.returnJsonArray(results as IDataObject[]),
{ itemData: { item: i } },
);
returnData.push(...executionData);
} else if (operation === 'delete') {
const datapointId = this.getNodeParameter('datapointId', i) as string;
const data: IDataObject = {
goalName,
datapointId,
};
results = await deleteDatapoint.call(this, data);
const executionData = this.helpers.constructExecutionMetaData(
this.helpers.returnJsonArray(results as IDataObject[]),
{ itemData: { item: i } },
);
returnData.push(...executionData);
}
}
} catch (error) {
if (this.continueOnFail()) {
returnData.push({ error: error.message, json: {}, itemIndex: i });
continue;
}
throw error;
}
}
return [returnData];
}
}