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

528 lines
12 KiB
TypeScript
Raw Normal View History

2020-01-29 23:17:42 -08:00
import {
IExecuteFunctions,
} from 'n8n-core';
2020-01-23 16:07:18 -08:00
import {
2020-01-29 23:17:42 -08:00
IDataObject,
ILoadOptionsFunctions,
2020-01-23 16:07:18 -08:00
INodeExecutionData,
INodePropertyOptions,
2020-01-23 16:07:18 -08:00
INodeType,
INodeTypeDescription,
:sparkles: Improve node error handling (#1309) * Add path mapping and response error interfaces * Add error handling and throwing functionality * Refactor error handling into a single function * Re-implement error handling in Hacker News node * Fix linting details * Re-implement error handling in Spotify node * Re-implement error handling in G Suite Admin node * :construction: create basic setup NodeError * :construction: add httpCodes * :construction: add path priolist * :construction: handle statusCode in error, adjust interfaces * :construction: fixing type issues w/Ivan * :construction: add error exploration * 👔 fix linter issues * :wrench: improve object check * :construction: remove path passing from NodeApiError * :construction: add multi error + refactor findProperty method * 👔 allow any * :wrench: handle multi error message callback * :zap: change return type of callback * :zap: add customCallback to MultiError * :construction: refactor to use INode * :hammer: handle arrays, continue search after first null property found * 🚫 refactor method access * :construction: setup NodeErrorView * :zap: change timestamp to Date.now * :books: Add documentation for methods and constants * :construction: change message setting * 🚚 move NodeErrors to workflow * :sparkles: add new ErrorView for Nodes * :art: improve error notification * :art: refactor interfaces * :zap: add WorkflowOperationError, refactor error throwing * 👕 fix linter issues * :art: rename param * :bug: fix handling normal errors * :zap: add usage of NodeApiError * :art: fix throw new error instead of constructor * :art: remove unnecessary code/comments * :art: adjusted spacing + updated status messages * :art: fix tab indentation * ✨ Replace current errors with custom errors (#1576) * :zap: Introduce NodeApiError in catch blocks * :zap: Introduce NodeOperationError in nodes * :zap: Add missing errors and remove incompatible * :zap: Fix NodeOperationError in incompatible nodes * :wrench: Adjust error handling in missed nodes PayPal, FileMaker, Reddit, Taiga and Facebook Graph API nodes * :hammer: Adjust Strava Trigger node error handling * :hammer: Adjust AWS nodes error handling * :hammer: Remove duplicate instantiation of NodeApiError * :bug: fix strava trigger node error handling * Add XML parsing to NodeApiError constructor (#1633) * :bug: Remove type annotation from catch variable * :sparkles: Add XML parsing to NodeApiError * :zap: Simplify error handling in Rekognition node * :zap: Pass in XML flag in generic functions * :fire: Remove try/catch wrappers at call sites * :hammer: Refactor setting description from XML * :hammer: Refactor let to const in resource loaders * :zap: Find property in parsed XML * :zap: Change let to const * :fire: Remove unneeded try/catch block * :shirt: Fix linting issues * :bug: Fix errors from merge conflict resolution * :zap: Add custom errors to latest contributions * :shirt: Fix linting issues * :zap: Refactor MongoDB helpers for custom errors * :bug: Correct custom error type * :zap: Apply feedback to A nodes * :zap: Apply feedback to missed A node * :zap: Apply feedback to B-D nodes * :zap: Apply feedback to E-F nodes * :zap: Apply feedback to G nodes * :zap: Apply feedback to H-L nodes * :zap: Apply feedback to M nodes * :zap: Apply feedback to P nodes * :zap: Apply feedback to R nodes * :zap: Apply feedback to S nodes * :zap: Apply feedback to T nodes * :zap: Apply feedback to V-Z nodes * :zap: Add HTTP code to iterable node error * :hammer: Standardize e as error * :hammer: Standardize err as error * :zap: Fix error handling for non-standard nodes Co-authored-by: Ben Hesseldieck <b.hesseldieck@gmail.com> Co-authored-by: Ben Hesseldieck <b.hesseldieck@gmail.com> Co-authored-by: Ben Hesseldieck <1849459+BHesseldieck@users.noreply.github.com>
2021-04-16 09:33:36 -07:00
NodeOperationError,
2020-01-23 16:07:18 -08:00
} from 'n8n-workflow';
import {
set,
} from 'lodash';
import * as moment from 'moment-timezone';
2020-01-23 16:07:18 -08:00
export class DateTime implements INodeType {
description: INodeTypeDescription = {
displayName: 'Date & Time',
name: 'dateTime',
icon: 'fa:clock',
2020-01-23 16:07:18 -08:00
group: ['transform'],
version: 1,
description: 'Allows you to manipulate date and time values',
subtitle: '={{$parameter["action"]}}',
2020-01-23 16:07:18 -08:00
defaults: {
name: 'Date & Time',
color: '#408000',
},
inputs: ['main'],
outputs: ['main'],
properties: [
{
displayName: 'Action',
name: 'action',
type: 'options',
options: [
{
name: 'Calculate a Date',
description: 'Add or subtract time from a date',
value: 'calculate',
},
2020-01-23 16:07:18 -08:00
{
name: 'Format a Date',
2020-01-29 23:17:42 -08:00
description: 'Convert a date to a different format',
2020-10-22 06:46:03 -07:00
value: 'format',
2020-01-23 16:07:18 -08:00
},
],
default: 'format',
},
{
2020-02-07 23:12:15 -08:00
displayName: 'Value',
name: 'value',
2020-01-23 16:07:18 -08:00
displayOptions: {
show: {
2020-02-07 23:12:15 -08:00
action: [
2020-01-25 14:14:54 -08:00
'format',
2020-01-23 16:07:18 -08:00
],
},
},
type: 'string',
default: '',
2020-02-07 23:12:15 -08:00
description: 'The value that should be converted.',
2020-01-23 16:07:18 -08:00
required: true,
},
2020-02-07 23:12:15 -08:00
{
displayName: 'Property Name',
name: 'dataPropertyName',
type: 'string',
default: 'data',
required: true,
displayOptions: {
show: {
action: [
'format',
],
},
},
description: 'Name of the property to which to write the converted date.',
},
2020-01-25 14:14:54 -08:00
{
displayName: 'Custom Format',
name: 'custom',
displayOptions: {
show: {
action: [
2020-01-25 14:14:54 -08:00
'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: [
2020-01-25 14:14:54 -08:00
'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: [
2020-01-25 14:14:54 -08:00
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: [
2020-10-22 06:46:03 -07:00
'format',
2020-01-23 16:07:18 -08:00
],
},
},
type: 'collection',
placeholder: 'Add Option',
default: {},
options: [
2020-02-07 23:12:15 -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-23 16:07:18 -08:00
{
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
},
2020-01-29 23:17:42 -08:00
{
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
},
],
},
{
displayName: 'Date Value',
name: 'value',
displayOptions: {
show: {
action: [
'calculate',
],
},
},
type: 'string',
default: '',
description: 'The date string or timestamp from which you want to add/subtract time.',
required: true,
},
{
displayName: 'Operation',
name: 'operation',
displayOptions: {
show: {
action: [
'calculate',
],
},
},
type: 'options',
options: [
{
name: 'Add',
value: 'add',
description: 'Add time to Date Value',
},
{
name: 'Subtract',
value: 'subtract',
description: 'Subtract time from Date Value',
},
],
default: 'add',
required: true,
},
{
displayName: 'Duration',
name: 'duration',
displayOptions: {
show: {
action: [
'calculate',
],
},
},
type: 'number',
typeOptions: {
minValue: 0,
},
default: 0,
required: true,
description: 'E.g. enter “10” then select “Days” if you want to add 10 days to Date Value.',
},
{
displayName: 'Time Unit',
name: 'timeUnit',
description: 'Time unit for Duration parameter above.',
displayOptions: {
show: {
action: [
'calculate',
],
},
},
type: 'options',
options: [
{
name: 'Quarters',
value: 'quarters',
},
{
name: 'Years',
value: 'years',
},
{
name: 'Months',
value: 'months',
},
{
name: 'Weeks',
value: 'weeks',
},
{
name: 'Days',
value: 'days',
},
{
name: 'Hours',
value: 'hours',
},
{
name: 'Minutes',
value: 'minutes',
},
{
name: 'Seconds',
value: 'seconds',
},
{
name: 'Milliseconds',
value: 'milliseconds',
},
],
default: 'days',
required: true,
},
{
displayName: 'Property Name',
name: 'dataPropertyName',
type: 'string',
default: 'data',
required: true,
displayOptions: {
show: {
action: [
'calculate',
],
},
},
description: 'Name of the output property to which to write the converted date.',
},
{
displayName: 'Options',
name: 'options',
type: 'collection',
placeholder: 'Add Option',
default: {},
displayOptions: {
show: {
action: [
'calculate',
],
},
},
options: [
{
displayName: 'From Format',
name: 'fromFormat',
type: 'string',
default: '',
description: 'Format for parsing the value as a date. If unrecognized, specify the <a href="https://docs.n8n.io/nodes/n8n-nodes-base.dateTime/#faqs">format</a> for the value.',
},
],
},
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;
},
2020-10-22 06:46:03 -07:00
},
2020-01-23 16:07:18 -08:00
};
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-02-07 23:12:15 -08:00
const currentDate = this.getNodeParameter('value', i) as string;
const dataPropertyName = this.getNodeParameter('dataPropertyName', 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
if (currentDate === undefined) {
2020-02-07 23:12:15 -08:00
continue;
2020-01-23 16:07:18 -08:00
}
if (options.fromFormat === undefined && !moment(currentDate as string | number).isValid()) {
:sparkles: Improve node error handling (#1309) * Add path mapping and response error interfaces * Add error handling and throwing functionality * Refactor error handling into a single function * Re-implement error handling in Hacker News node * Fix linting details * Re-implement error handling in Spotify node * Re-implement error handling in G Suite Admin node * :construction: create basic setup NodeError * :construction: add httpCodes * :construction: add path priolist * :construction: handle statusCode in error, adjust interfaces * :construction: fixing type issues w/Ivan * :construction: add error exploration * 👔 fix linter issues * :wrench: improve object check * :construction: remove path passing from NodeApiError * :construction: add multi error + refactor findProperty method * 👔 allow any * :wrench: handle multi error message callback * :zap: change return type of callback * :zap: add customCallback to MultiError * :construction: refactor to use INode * :hammer: handle arrays, continue search after first null property found * 🚫 refactor method access * :construction: setup NodeErrorView * :zap: change timestamp to Date.now * :books: Add documentation for methods and constants * :construction: change message setting * 🚚 move NodeErrors to workflow * :sparkles: add new ErrorView for Nodes * :art: improve error notification * :art: refactor interfaces * :zap: add WorkflowOperationError, refactor error throwing * 👕 fix linter issues * :art: rename param * :bug: fix handling normal errors * :zap: add usage of NodeApiError * :art: fix throw new error instead of constructor * :art: remove unnecessary code/comments * :art: adjusted spacing + updated status messages * :art: fix tab indentation * ✨ Replace current errors with custom errors (#1576) * :zap: Introduce NodeApiError in catch blocks * :zap: Introduce NodeOperationError in nodes * :zap: Add missing errors and remove incompatible * :zap: Fix NodeOperationError in incompatible nodes * :wrench: Adjust error handling in missed nodes PayPal, FileMaker, Reddit, Taiga and Facebook Graph API nodes * :hammer: Adjust Strava Trigger node error handling * :hammer: Adjust AWS nodes error handling * :hammer: Remove duplicate instantiation of NodeApiError * :bug: fix strava trigger node error handling * Add XML parsing to NodeApiError constructor (#1633) * :bug: Remove type annotation from catch variable * :sparkles: Add XML parsing to NodeApiError * :zap: Simplify error handling in Rekognition node * :zap: Pass in XML flag in generic functions * :fire: Remove try/catch wrappers at call sites * :hammer: Refactor setting description from XML * :hammer: Refactor let to const in resource loaders * :zap: Find property in parsed XML * :zap: Change let to const * :fire: Remove unneeded try/catch block * :shirt: Fix linting issues * :bug: Fix errors from merge conflict resolution * :zap: Add custom errors to latest contributions * :shirt: Fix linting issues * :zap: Refactor MongoDB helpers for custom errors * :bug: Correct custom error type * :zap: Apply feedback to A nodes * :zap: Apply feedback to missed A node * :zap: Apply feedback to B-D nodes * :zap: Apply feedback to E-F nodes * :zap: Apply feedback to G nodes * :zap: Apply feedback to H-L nodes * :zap: Apply feedback to M nodes * :zap: Apply feedback to P nodes * :zap: Apply feedback to R nodes * :zap: Apply feedback to S nodes * :zap: Apply feedback to T nodes * :zap: Apply feedback to V-Z nodes * :zap: Add HTTP code to iterable node error * :hammer: Standardize e as error * :hammer: Standardize err as error * :zap: Fix error handling for non-standard nodes Co-authored-by: Ben Hesseldieck <b.hesseldieck@gmail.com> Co-authored-by: Ben Hesseldieck <b.hesseldieck@gmail.com> Co-authored-by: Ben Hesseldieck <1849459+BHesseldieck@users.noreply.github.com>
2021-04-16 09:33:36 -07:00
throw new NodeOperationError(this.getNode(), 'The date input format could not be recognized. Please set the "From Format" field');
2020-01-23 16:07:18 -08:00
}
2020-02-07 23:12:15 -08:00
if (Number.isInteger(currentDate as unknown as number)) {
newDate = moment.unix(currentDate as unknown 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;
2020-02-07 23:12:15 -08:00
if (dataPropertyName.includes('.')) {
2020-01-29 23:17:42 -08:00
// Uses dot notation so copy all data
newItem = {
2020-02-07 23:12:15 -08:00
json: JSON.parse(JSON.stringify(item.json)),
2020-01-29 23:17:42 -08:00
};
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 = {
2020-02-07 23:12:15 -08:00
json: { ...item.json },
2020-01-29 23:17:42 -08:00
};
2020-01-23 16:07:18 -08:00
}
2020-01-29 23:17:42 -08:00
if (item.binary !== undefined) {
newItem.binary = item.binary;
}
2020-02-07 23:12:15 -08:00
set(newItem, `json.${dataPropertyName}`, newDate);
2020-01-29 23:17:42 -08:00
returnData.push(newItem);
2020-01-23 16:07:18 -08:00
}
if (action === 'calculate') {
const dateValue = this.getNodeParameter('value', i) as string;
const operation = this.getNodeParameter('operation', i) as 'add' | 'subtract';
const duration = this.getNodeParameter('duration', i) as number;
const timeUnit = this.getNodeParameter('timeUnit', i) as moment.DurationInputArg2;
const { fromFormat } = this.getNodeParameter('options', i) as { fromFormat?: string };
const dataPropertyName = this.getNodeParameter('dataPropertyName', i) as string;
const newDate = fromFormat
? parseDateByFormat(dateValue, fromFormat)
: parseDateByDefault(dateValue);
operation === 'add'
? newDate.add(duration, timeUnit).utc().format()
: newDate.subtract(duration, timeUnit).utc().format();
let newItem: INodeExecutionData;
if (dataPropertyName.includes('.')) {
// Uses dot notation so copy all data
newItem = {
json: JSON.parse(JSON.stringify(item.json)),
};
} else {
// Does not use dot notation so shallow copy is enough
newItem = {
json: { ...item.json },
};
}
if (item.binary !== undefined) {
newItem.binary = item.binary;
}
set(newItem, `json.${dataPropertyName}`, 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
}
}
function parseDateByFormat(value: string, fromFormat: string) {
const date = moment(value, fromFormat, true);
if (moment(date).isValid()) return date;
throw new Error('Date input cannot be parsed. Please recheck the value and the "From Format" field.');
}
function parseDateByDefault(value: string) {
const isoValue = getIsoValue(value);
if (moment(isoValue).isValid()) return moment(isoValue);
throw new Error('Unrecognized date input. Please specify a format in the "From Format" field.');
}
function getIsoValue(value: string) {
try {
return new Date(value).toISOString(); // may throw due to unpredictable input
} catch (error) {
throw new Error('Unrecognized date input. Please specify a format in the "From Format" field.');
}
}