n8n/packages/nodes-base/nodes/DateTime.node.ts

299 lines
7.1 KiB
TypeScript
Raw Normal View History

2020-01-29 23:17:42 -08:00
import * as moment from 'moment-timezone';
import { get, set } from 'lodash';
2020-01-23 16:07:18 -08:00
import { IExecuteFunctions } from 'n8n-core';
import {
2020-01-29 23:17:42 -08:00
IDataObject,
ILoadOptionsFunctions,
2020-01-23 16:07:18 -08:00
INodeExecutionData,
INodeType,
INodeTypeDescription,
INodePropertyOptions,
} from 'n8n-workflow';
export class DateTime implements INodeType {
description: INodeTypeDescription = {
displayName: 'Date & Time',
name: 'dateTime',
icon: 'fa:calendar',
group: ['transform'],
version: 1,
description: 'Allows you to manipulate date and time values',
defaults: {
name: 'Date & Time',
color: '#408000',
},
inputs: ['main'],
outputs: ['main'],
properties: [
{
displayName: 'Action',
name: 'action',
type: 'options',
options: [
{
name: 'Format a Date',
2020-01-29 23:17:42 -08:00
description: 'Convert a date to a different format',
2020-01-23 16:07:18 -08:00
value: 'format'
},
],
default: 'format',
},
{
2020-01-29 23:17:42 -08:00
displayName: 'Key Name',
name: 'keyName',
2020-01-23 16:07:18 -08:00
displayOptions: {
show: {
action:[
2020-01-25 14:14:54 -08:00
'format',
2020-01-23 16:07:18 -08:00
],
},
},
type: 'string',
default: '',
2020-01-29 23:17:42 -08:00
description: 'The name of the key of which the value should be converted.',
2020-01-23 16:07:18 -08:00
required: true,
},
2020-01-25 14:14:54 -08:00
{
displayName: 'Custom Format',
name: 'custom',
displayOptions: {
show: {
action:[
'format',
],
},
},
type: 'boolean',
default: false,
2020-01-29 23:17:42 -08:00
description: 'If a predefined format should be selected or custom format entered.',
2020-01-25 14:14:54 -08:00
},
{
displayName: 'To Format',
name: 'toFormat',
displayOptions: {
show: {
action:[
'format',
],
custom: [
true,
],
},
},
type: 'string',
default: '',
2020-01-29 23:17:42 -08:00
placeholder: 'YYYY-MM-DD',
description: 'The format to convert the date to.',
2020-01-25 14:14:54 -08:00
},
2020-01-23 16:07:18 -08:00
{
displayName: 'To Format',
name: 'toFormat',
type: 'options',
displayOptions: {
show: {
action:[
2020-01-25 14:14:54 -08:00
'format',
],
custom:[
false,
2020-01-23 16:07:18 -08:00
],
},
},
options: [
{
name: 'MM/DD/YYYY',
value: 'MM/DD/YYYY',
description: 'Example: 09/04/1986',
},
{
name: 'YYYY/MM/DD',
value: 'YYYY/MM/DD',
description: 'Example: 1986/04/09',
},
{
name: 'MMMM DD YYYY',
value: 'MMMM DD YYYY',
description: 'Example: April 09 1986',
},
{
name: 'MM-DD-YYYY',
value: 'MM-DD-YYYY',
description: 'Example: 09-04-1986',
},
{
name: 'YYYY-MM-DD',
value: 'YYYY-MM-DD',
description: 'Example: 1986-04-09',
},
{
name: 'Unix Timestamp',
value: 'X',
description: 'Example: 513388800.879',
},
{
name: 'Unix Ms Timestamp',
value: 'x',
description: 'Example: 513388800',
},
],
default: 'MM/DD/YYYY',
2020-01-29 23:17:42 -08:00
description: 'The format to convert the date to.',
2020-01-23 16:07:18 -08:00
},
{
displayName: 'Options',
name: 'options',
displayOptions: {
show: {
action:[
'format'
],
},
},
type: 'collection',
placeholder: 'Add Option',
default: {},
options: [
{
displayName: 'From Timezone',
name: 'fromTimezone',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getTimezones',
},
default: 'UTC',
2020-01-29 23:17:42 -08:00
description: 'The timezone to convert from.',
2020-01-23 16:07:18 -08:00
},
{
displayName: 'From Format',
name: 'fromFormat',
type: 'string',
default: '',
description: 'In case the input format is not recognized you can provide the format ',
},
{
2020-01-29 23:17:42 -08:00
displayName: 'New Key Name',
name: 'newKeyName',
type: 'string',
default: 'newDate',
description: 'If set will the new date be added under the new key name and the existing one will not be touched.',
},
{
displayName: 'To Timezone',
name: 'toTimezone',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getTimezones',
},
default: 'UTC',
description: 'The timezone to convert to.',
2020-01-23 16:07:18 -08:00
},
],
},
],
};
methods = {
loadOptions: {
// Get all the timezones to display them to user so that he can
// select them easily
async getTimezones(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]> {
const returnData: INodePropertyOptions[] = [];
for (const timezone of moment.tz.names()) {
const timezoneName = timezone;
const timezoneId = timezone;
returnData.push({
name: timezoneName,
value: timezoneId,
});
}
return returnData;
},
}
};
async execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]> {
const items = this.getInputData();
const length = items.length as unknown as number;
2020-01-29 23:17:42 -08:00
const returnData: INodeExecutionData[] = [];
const workflowTimezone = this.getTimezone();
let item: INodeExecutionData;
2020-01-23 16:07:18 -08:00
for (let i = 0; i < length; i++) {
const action = this.getNodeParameter('action', 0) as string;
2020-01-29 23:17:42 -08:00
item = items[i];
2020-01-23 16:07:18 -08:00
if (action === 'format') {
2020-01-29 23:17:42 -08:00
const keyName = this.getNodeParameter('keyName', i) as string;
2020-01-23 16:07:18 -08:00
const toFormat = this.getNodeParameter('toFormat', i) as string;
const options = this.getNodeParameter('options', i) as IDataObject;
let newDate;
2020-01-29 23:17:42 -08:00
const currentDate = get(item.json, keyName);
if (currentDate === undefined) {
throw new Error(`The key ${keyName} does not exist on the input data`);
2020-01-23 16:07:18 -08:00
}
2020-01-29 23:17:42 -08:00
if (!moment(currentDate as string | number).isValid()) {
throw new Error('The date input format could not be recognized. Please set the "From Format" field');
2020-01-23 16:07:18 -08:00
}
2020-01-29 23:17:42 -08:00
if (Number.isInteger(currentDate as number)) {
newDate = moment.unix(currentDate as number);
2020-01-23 16:07:18 -08:00
} else {
2020-01-29 23:17:42 -08:00
if (options.fromTimezone || options.toTimezone) {
const fromTimezone = options.fromTimezone || workflowTimezone;
if (options.fromFormat) {
newDate = moment.tz(currentDate as string, options.fromFormat as string, fromTimezone as string);
} else {
newDate = moment.tz(currentDate as string, fromTimezone as string);
}
} else {
if (options.fromFormat) {
newDate = moment(currentDate as string, options.fromFormat as string);
} else {
newDate = moment(currentDate as string);
}
2020-01-23 16:07:18 -08:00
}
}
2020-01-29 23:17:42 -08:00
if (options.toTimezone || options.fromTimezone) {
// If either a source or a target timezone got defined the
// timezone of the date has to be changed. If a target-timezone
// is set use it else fall back to workflow timezone.
newDate = newDate.tz(options.toTimezone as string || workflowTimezone);
}
newDate = newDate.format(toFormat);
let newItem: INodeExecutionData;
if (keyName.includes('.')) {
// Uses dot notation so copy all data
newItem = {
json: JSON.parse(JSON.stringify(items[i].json)),
};
2020-01-23 16:07:18 -08:00
} else {
2020-01-29 23:17:42 -08:00
// Does not use dot notation so shallow copy is enough
newItem = {
json: { ...items[i].json },
};
2020-01-23 16:07:18 -08:00
}
2020-01-29 23:17:42 -08:00
if (item.binary !== undefined) {
newItem.binary = item.binary;
}
if (options.newKeyName) {
set(newItem, `json.${options.newKeyName}`, newDate);
} else {
set(newItem, `json.${keyName}`, newDate);
}
returnData.push(newItem);
2020-01-23 16:07:18 -08:00
}
}
2020-01-29 23:17:42 -08:00
return this.prepareOutputData(returnData);
2020-01-23 16:07:18 -08:00
}
}