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

186 lines
4.6 KiB
TypeScript
Raw Normal View History

import type {
IExecuteFunctions,
IDataObject,
INodeExecutionData,
INodeType,
INodeTypeDescription,
} from 'n8n-workflow';
import { NodeOperationError } from 'n8n-workflow';
import {
endOfDayDataFields,
endOfDayDataOperations,
exchangeFields,
exchangeOperations,
tickerFields,
tickerOperations,
} from './descriptions';
import {
format,
marketstackApiRequest,
marketstackApiRequestAllItems,
validateTimeOptions,
} from './GenericFunctions';
import type { EndOfDayDataFilters, Operation, Resource } from './types';
export class Marketstack implements INodeType {
description: INodeTypeDescription = {
displayName: 'Marketstack',
name: 'marketstack',
subtitle: '={{$parameter["operation"] + ": " + $parameter["resource"]}}',
icon: 'file:marketstack.svg',
group: ['transform'],
version: 1,
description: 'Consume Marketstack API',
defaults: {
name: 'Marketstack',
},
inputs: ['main'],
outputs: ['main'],
credentials: [
{
name: 'marketstackApi',
required: true,
},
],
properties: [
{
displayName: 'Resource',
name: 'resource',
type: 'options',
refactor: Apply more nodelinting rules (#3324) * :pencil2: Alphabetize lint rules * :fire: Remove duplicates * :zap: Update `lintfix` script * :shirt: Apply `node-param-operation-without-no-data-expression` (#3329) * :shirt: Apply `node-param-operation-without-no-data-expression` * :shirt: Add exceptions * :shirt: Apply `node-param-description-weak` (#3328) Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Apply `node-param-option-value-duplicate` (#3331) * :shirt: Apply `node-param-description-miscased-json` (#3337) * :shirt: Apply `node-param-display-name-excess-inner-whitespace` (#3335) Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Apply `node-param-type-options-missing-from-limit` (#3336) * Rule workig as intended * :pencil2: Uncomment rules Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Apply `node-param-option-name-duplicate` (#3338) Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Apply `node-param-description-wrong-for-simplify` (#3334) * :zap: fix * :zap: exceptions * :zap: changed rule ignoring from file to line * :shirt: Apply `node-param-resource-without-no-data-expression` (#3339) * :shirt: Apply `node-param-display-name-untrimmed` (#3341) * :shirt: Apply `node-param-display-name-miscased-id` (#3340) Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Apply `node-param-resource-with-plural-option` (#3342) * :shirt: Apply `node-param-description-wrong-for-upsert` (#3333) * :zap: fix * :zap: replaced record with contact in description * :zap: fix Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Apply `node-param-option-description-identical-to-name` (#3343) * :shirt: Apply `node-param-option-name-containing-star` (#3347) * :shirt: Apply `node-param-display-name-wrong-for-update-fields` (#3348) * :shirt: Apply `node-param-option-name-wrong-for-get-all` (#3345) * :zap: fix * :zap: exceptions * :shirt: Apply node-param-display-name-wrong-for-simplify (#3344) * Rule working as intended * Uncomented other rules * :shirt: Undo and add exceptions Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :zap: Alphabetize lint rules * :zap: Restore `lintfix` script Co-authored-by: Michael Kret <88898367+michael-radency@users.noreply.github.com> Co-authored-by: agobrech <45268029+agobrech@users.noreply.github.com>
2022-05-20 14:47:24 -07:00
noDataExpression: true,
options: [
{
name: 'End-of-Day Data',
value: 'endOfDayData',
description: 'Stock market closing data',
},
{
name: 'Exchange',
value: 'exchange',
description: 'Stock market exchange',
},
{
name: 'Ticker',
value: 'ticker',
description: 'Stock market symbol',
},
],
default: 'endOfDayData',
required: true,
},
...endOfDayDataOperations,
...endOfDayDataFields,
...exchangeOperations,
...exchangeFields,
...tickerOperations,
...tickerFields,
],
};
async execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]> {
const items = this.getInputData();
const resource = this.getNodeParameter('resource', 0) as Resource;
const operation = this.getNodeParameter('operation', 0) as Operation;
let responseData: any;
const returnData: INodeExecutionData[] = [];
for (let i = 0; i < items.length; i++) {
try {
if (resource === 'endOfDayData') {
if (operation === 'getAll') {
// ----------------------------------
// endOfDayData: getAll
// ----------------------------------
const qs: IDataObject = {
symbols: this.getNodeParameter('symbols', i),
};
const { latest, specificDate, dateFrom, dateTo, ...rest } = this.getNodeParameter(
'filters',
i,
) as EndOfDayDataFilters;
validateTimeOptions.call(this, [
latest !== undefined && latest,
specificDate !== undefined,
dateFrom !== undefined && dateTo !== undefined,
]);
if (Object.keys(rest).length) {
Object.assign(qs, rest);
}
let endpoint: string;
if (latest) {
endpoint = '/eod/latest';
} else if (specificDate) {
endpoint = `/eod/${format(specificDate)}`;
} else {
if (!dateFrom || !dateTo) {
throw new NodeOperationError(
this.getNode(),
'Please enter a start and end date to filter by timeframe.',
{ itemIndex: i },
);
}
endpoint = '/eod';
qs.date_from = format(dateFrom);
qs.date_to = format(dateTo);
}
responseData = await marketstackApiRequestAllItems.call(this, 'GET', endpoint, {}, qs);
}
} else if (resource === 'exchange') {
if (operation === 'get') {
// ----------------------------------
// exchange: get
// ----------------------------------
const exchange = this.getNodeParameter('exchange', i);
const endpoint = `/exchanges/${exchange}`;
responseData = await marketstackApiRequest.call(this, 'GET', endpoint);
}
} else if (resource === 'ticker') {
if (operation === 'get') {
// ----------------------------------
// ticker: get
// ----------------------------------
const symbol = this.getNodeParameter('symbol', i);
const endpoint = `/tickers/${symbol}`;
responseData = await marketstackApiRequest.call(this, 'GET', endpoint);
}
}
} catch (error) {
if (this.continueOnFail()) {
const executionErrorData = this.helpers.constructExecutionMetaData(
this.helpers.returnJsonArray({ error: error.message }),
{ itemData: { item: i } },
);
returnData.push(...executionErrorData);
continue;
}
throw error;
}
const executionData = this.helpers.constructExecutionMetaData(
this.helpers.returnJsonArray(responseData as IDataObject[]),
{ itemData: { item: i } },
);
returnData.push(...executionData);
}
return [returnData];
}
}