feat(Date & Time Node): Overhaul of the node (#5904)
* Setup versionized node * Fix node naming * Set all possible actions * Add Current Date operation * Add timezone to current date * feat add to date operator * Change output field name to camel case * Fix info box for luxons tip * Feat subtract to date operation * Feat format date operation * Fix to node field for format date * Feat rounding operation * Feat get in between date operation * Feat add extract date operation * Add generic function for parsing date * Remove moment methods from operations * Change moment to luxon for the rest of the operations * Fix Format date operation * Fix format value * Add timezone option for current date * Add tests, improve workflow settings for testing, toString the results * Change icon for V2 * Revert "Change icon for V2" This reverts commit 46b59bea2ec6dd02a22f8d07a9736b42d751d10f. * Change workflow test name * Fix ui bug for custom format * Fix default value for format operation * Fix info box for rounding operation * Change default for units for between time operation * Inprove fields and resort time units * Fix extract week number * Resolve issue with formating and timezones * Fix field name and unit order * ⚡ restored removed test case, sync v1 with curent master * ⚡ parseDate update to support timestamps, tests * Keep same field for substract and add time * Update unit test * Improve visibility, add iso to string option * Update option naming --------- Co-authored-by: Michael Kret <michael.k@radency.com>
This commit is contained in:
agobrech
GitHub
210
packages/nodes-base/nodes/DateTime/V2/DateTimeV2.node.ts
Normal file
210
packages/nodes-base/nodes/DateTime/V2/DateTimeV2.node.ts
Normal file
@@ -0,0 +1,210 @@
|
||||
import type {
|
||||
IDataObject,
|
||||
IExecuteFunctions,
|
||||
INodeExecutionData,
|
||||
INodeType,
|
||||
INodeTypeBaseDescription,
|
||||
INodeTypeDescription,
|
||||
} from 'n8n-workflow';
|
||||
import { NodeOperationError } from 'n8n-workflow';
|
||||
|
||||
import { CurrentDateDescription } from './CurrentDateDescription';
|
||||
import { AddToDateDescription } from './AddToDateDescription';
|
||||
import { SubtractFromDateDescription } from './SubtractFromDateDescription';
|
||||
import { FormatDateDescription } from './FormatDateDescription';
|
||||
import { RoundDateDescription } from './RoundDateDescription';
|
||||
import { GetTimeBetweenDatesDescription } from './GetTimeBetweenDates';
|
||||
import type { DateTimeUnit, DurationUnit } from 'luxon';
|
||||
import { DateTime } from 'luxon';
|
||||
import { ExtractDateDescription } from './ExtractDateDescription';
|
||||
import { parseDate } from './GenericFunctions';
|
||||
|
||||
export class DateTimeV2 implements INodeType {
|
||||
description: INodeTypeDescription;
|
||||
|
||||
constructor(baseDescription: INodeTypeBaseDescription) {
|
||||
this.description = {
|
||||
...baseDescription,
|
||||
version: 2,
|
||||
defaults: {
|
||||
name: 'Date & Time',
|
||||
color: '#408000',
|
||||
},
|
||||
inputs: ['main'],
|
||||
outputs: ['main'],
|
||||
properties: [
|
||||
{
|
||||
displayName: 'Operation',
|
||||
name: 'operation',
|
||||
type: 'options',
|
||||
noDataExpression: true,
|
||||
options: [
|
||||
{
|
||||
name: 'Add to a Date',
|
||||
value: 'addToDate',
|
||||
},
|
||||
{
|
||||
name: 'Extract Part of a Date',
|
||||
value: 'extractDate',
|
||||
},
|
||||
{
|
||||
name: 'Format a Date',
|
||||
value: 'formatDate',
|
||||
},
|
||||
{
|
||||
name: 'Get Current Date',
|
||||
value: 'getCurrentDate',
|
||||
},
|
||||
{
|
||||
name: 'Get Time Between Dates',
|
||||
value: 'getTimeBetweenDates',
|
||||
},
|
||||
{
|
||||
name: 'Round a Date',
|
||||
value: 'roundDate',
|
||||
},
|
||||
{
|
||||
name: 'Subtract From a Date',
|
||||
value: 'subtractFromDate',
|
||||
},
|
||||
],
|
||||
default: 'getCurrentDate',
|
||||
},
|
||||
...CurrentDateDescription,
|
||||
...AddToDateDescription,
|
||||
...SubtractFromDateDescription,
|
||||
...FormatDateDescription,
|
||||
...RoundDateDescription,
|
||||
...GetTimeBetweenDatesDescription,
|
||||
...ExtractDateDescription,
|
||||
],
|
||||
};
|
||||
}
|
||||
|
||||
async execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]> {
|
||||
const items = this.getInputData();
|
||||
const returnData: INodeExecutionData[] = [];
|
||||
const responseData = [];
|
||||
const operation = this.getNodeParameter('operation', 0);
|
||||
const workflowTimezone = this.getTimezone();
|
||||
|
||||
for (let i = 0; i < items.length; i++) {
|
||||
if (operation === 'getCurrentDate') {
|
||||
const includeTime = this.getNodeParameter('includeTime', i) as boolean;
|
||||
const outputFieldName = this.getNodeParameter('outputFieldName', i) as string;
|
||||
const { timezone } = this.getNodeParameter('options', i) as {
|
||||
timezone: string;
|
||||
};
|
||||
|
||||
const newLocal = timezone ? timezone : workflowTimezone;
|
||||
if (DateTime.now().setZone(newLocal).invalidReason === 'unsupported zone') {
|
||||
throw new NodeOperationError(
|
||||
this.getNode(),
|
||||
`The timezone ${newLocal} is not valid. Please check the timezone.`,
|
||||
);
|
||||
}
|
||||
responseData.push(
|
||||
includeTime
|
||||
? { [outputFieldName]: DateTime.now().setZone(newLocal).toString() }
|
||||
: {
|
||||
[outputFieldName]: DateTime.now().setZone(newLocal).startOf('day').toString(),
|
||||
},
|
||||
);
|
||||
} else if (operation === 'addToDate') {
|
||||
const addToDate = this.getNodeParameter('magnitude', i) as string;
|
||||
const timeUnit = this.getNodeParameter('timeUnit', i) as string;
|
||||
const duration = this.getNodeParameter('duration', i) as number;
|
||||
const outputFieldName = this.getNodeParameter('outputFieldName', i) as string;
|
||||
|
||||
const dateToAdd = parseDate.call(this, addToDate, workflowTimezone);
|
||||
const returnedDate = dateToAdd.plus({ [timeUnit]: duration });
|
||||
responseData.push({ [outputFieldName]: returnedDate.toString() });
|
||||
} else if (operation === 'subtractFromDate') {
|
||||
const subtractFromDate = this.getNodeParameter('magnitude', i) as string;
|
||||
const timeUnit = this.getNodeParameter('timeUnit', i) as string;
|
||||
const duration = this.getNodeParameter('duration', i) as number;
|
||||
const outputFieldName = this.getNodeParameter('outputFieldName', i) as string;
|
||||
|
||||
const dateToAdd = parseDate.call(this, subtractFromDate, workflowTimezone);
|
||||
const returnedDate = dateToAdd.minus({ [timeUnit]: duration });
|
||||
responseData.push({ [outputFieldName]: returnedDate.toString() });
|
||||
} else if (operation === 'formatDate') {
|
||||
const date = this.getNodeParameter('date', i) as string;
|
||||
const format = this.getNodeParameter('format', i) as string;
|
||||
const outputFieldName = this.getNodeParameter('outputFieldName', i) as string;
|
||||
const { timezone } = this.getNodeParameter('options', i) as { timezone: boolean };
|
||||
|
||||
const dateLuxon = timezone
|
||||
? parseDate.call(this, date, workflowTimezone)
|
||||
: parseDate.call(this, date);
|
||||
if (format === 'custom') {
|
||||
const customFormat = this.getNodeParameter('customFormat', i) as string;
|
||||
responseData.push({
|
||||
[outputFieldName]: dateLuxon.toFormat(customFormat),
|
||||
});
|
||||
} else {
|
||||
responseData.push({
|
||||
[outputFieldName]: dateLuxon.toFormat(format),
|
||||
});
|
||||
}
|
||||
} else if (operation === 'roundDate') {
|
||||
const date = this.getNodeParameter('date', i) as string;
|
||||
const mode = this.getNodeParameter('mode', i) as string;
|
||||
const outputFieldName = this.getNodeParameter('outputFieldName', i) as string;
|
||||
|
||||
const dateLuxon = parseDate.call(this, date, workflowTimezone);
|
||||
|
||||
if (mode === 'roundDown') {
|
||||
const toNearest = this.getNodeParameter('toNearest', i) as string;
|
||||
responseData.push({
|
||||
[outputFieldName]: dateLuxon.startOf(toNearest as DateTimeUnit).toString(),
|
||||
});
|
||||
} else if (mode === 'roundUp') {
|
||||
const to = this.getNodeParameter('to', i) as string;
|
||||
responseData.push({
|
||||
[outputFieldName]: dateLuxon
|
||||
.plus({ [to]: 1 })
|
||||
.startOf(to as DateTimeUnit)
|
||||
.toString(),
|
||||
});
|
||||
}
|
||||
} else if (operation === 'getTimeBetweenDates') {
|
||||
const startDate = this.getNodeParameter('startDate', i) as string;
|
||||
const endDate = this.getNodeParameter('endDate', i) as string;
|
||||
const unit = this.getNodeParameter('units', i) as DurationUnit[];
|
||||
const outputFieldName = this.getNodeParameter('outputFieldName', i) as string;
|
||||
const { isoString } = this.getNodeParameter('options', i) as {
|
||||
isoString: boolean;
|
||||
};
|
||||
|
||||
const luxonStartDate = parseDate.call(this, startDate, workflowTimezone);
|
||||
const luxonEndDate = parseDate.call(this, endDate, workflowTimezone);
|
||||
const duration = luxonEndDate.diff(luxonStartDate, unit);
|
||||
isoString
|
||||
? responseData.push({
|
||||
[outputFieldName]: duration.toString(),
|
||||
})
|
||||
: responseData.push({
|
||||
[outputFieldName]: duration.toObject(),
|
||||
});
|
||||
} else if (operation === 'extractDate') {
|
||||
const date = this.getNodeParameter('date', i) as string | DateTime;
|
||||
const outputFieldName = this.getNodeParameter('outputFieldName', i) as string;
|
||||
const part = this.getNodeParameter('part', i) as keyof DateTime | 'week';
|
||||
|
||||
const parsedDate = parseDate.call(this, date, workflowTimezone);
|
||||
const selectedPart = part === 'week' ? parsedDate.weekNumber : parsedDate.get(part);
|
||||
responseData.push({ [outputFieldName]: selectedPart });
|
||||
}
|
||||
|
||||
const executionData = this.helpers.constructExecutionMetaData(
|
||||
this.helpers.returnJsonArray(responseData as IDataObject[]),
|
||||
{
|
||||
itemData: { item: i },
|
||||
},
|
||||
);
|
||||
returnData.push(...executionData);
|
||||
}
|
||||
return this.prepareOutputData(returnData);
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user