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

469 lines
13 KiB
TypeScript
Raw Normal View History

import type { IExecuteFunctions } from 'n8n-core';
import type {
2021-10-20 20:35:51 -07:00
ICredentialsDecrypted,
ICredentialTestFunctions,
IDataObject,
2021-10-17 09:48:24 -07:00
ILoadOptionsFunctions,
:sparkles: Nodes as JSON and authentication redesign (#2401) * :sparkles: change FE to handle new object type * 🚸 improve UX of handling invalid credentials * 🚧 WIP * :art: fix typescript issues * 🐘 add migrations for all supported dbs * ✏️ add description to migrations * :zap: add credential update on import * :zap: resolve after merge issues * :shirt: fix lint issues * :zap: check credentials on workflow create/update * update interface * :shirt: fix ts issues * :zap: adaption to new credentials UI * :bug: intialize cache on BE for credentials check * :bug: fix undefined oldCredentials * :bug: fix deleting credential * :bug: fix check for undefined keys * :bug: fix disabling edit in execution * :art: just show credential name on execution view * ✏️ remove TODO * :zap: implement review suggestions * :zap: add cache to getCredentialsByType * ⏪ use getter instead of cache * ✏️ fix variable name typo * 🐘 include waiting nodes to migrations * :bug: fix reverting migrations command * :zap: update typeorm command * :sparkles: create db:revert command * 👕 fix lint error * :sparkles: Add optional authenticate method to credentials * :zap: Simplify code and add authentication support to MattermostApi * :shirt: Fix lint issue * :zap: Add support to own-mode * :shirt: Fix lint issue * :sparkles: Add support for predefined auth types bearer and headerAuth * :zap: Make sure that DateTime Node always returns strings * :zap: Add support for moment types to If Node * :zap: Make it possible for HTTP Request Node to use all credential types * :sparkles: Add basicAuth support * Add a new dropcontact node * :sparkles: First basic implementation of mainly JSON based nodes * :sparkles: Add fixedCollection support, added value parameter and expression support for value and property * Improvements to #2389 * :zap: Add credentials verification * :zap: Small improvement * :zap: set default time to 45 seconds * :sparkles: Add support for preSend and postReceive methods * :heavy_plus_sign: Add lodash merge and set depedency to workflow * :shirt: Fix lint issue * :zap: Improvements * :zap: Improvements * :zap: Improvements * :zap: Improvements * :zap: Improvements * :bug: Set siren and language correctly * :zap: Add support for requestDefaults * :zap: Add support for baseURL to httpRequest * :zap: Move baseURL to correct location * :sparkles: Add support for options loading * :bug: Fix error with fullAccess nodes * :sparkles: Add credential test functionality * :bug: Fix issue with OAuth autentication and lint issue * :zap: Fix build issue * :bug: Fix issue that url got always overwritten to empty * :sparkles: Add pagination support * :zap: Code fix required after merge * :zap: Remove not needed imports * :zap: Fix credential test * :sparkles: Add expression support for request properties and $self support on properties * :zap: Rename $self to $value * :shirt: Fix lint issue * :zap: Add example how to send data in path * :sparkles: Make it possible to not sent in dot notation * :sparkles: Add support for postReceive:rootProperty * :zap: Fix typo * :sparkles: Add support for postReceive:set * :zap: Some fixes * :zap: Small improvement * ;zap: Separate RoutingNode code * :zap: Simplify code and fix bug * :zap: Remove unused code * :sparkles: Make it possible to define "request" and "requestProperty" on options * :shirt: Fix lint issue * :zap: Change $credentials variables name * :sparkles: Enable expressions and access to credentials in requestDefaults * :zap: Make parameter option loading use RoutingNode.makeRoutingRequest * :sparkles: Allow requestOperations overwrite on LoadOptions * :sparkles: Make it possible to access current node parameters in loadOptions * :zap: Rename parameters variable to make future proof * :zap: Make it possible to use offset-pagination with body * :sparkles: Add support for queryAuth * :zap: Never return more items than requested * :sparkles: Make it possible to overwrite requestOperations on parameter and option level * :shirt: Fix lint issue * :sparkles: Allow simplified auth also with regular nodes * :sparkles: Add support for receiving binary data * :bug: Fix example node * :zap: Rename property "name" to "displayName" in loadOptions * :zap: Send data by default as "query" if nothing is set * :zap: Rename $self to $parent * :zap: Change to work with INodeExecutionData instead of IDataObject * :zap: Improve binaryData handling * :zap: Property design improvements * :zap: Fix property name * :rotating_light: Add some tests * :zap: Add also test for request * :zap: Improve test and fix issues * :zap: Improvements to loadOptions * :zap: Normalize loadOptions with rest of code * :zap: Add info text * :sparkles: Add support for $value in postReceive * :rotating_light: Add tests for RoutingNode.runNode * :zap: Remove TODOs and make url property optional * :zap: Fix bug and lint issue * :bug: Fix bug that not the correct property got used * :rotating_light: Add tests for CredentialsHelper.authenticate * :zap: Improve code and resolve expressions also everywhere for loadOptions and credential test requests * :sparkles: Make it possible to define multiple preSend and postReceive actions * :sparkles: Allow to define tests on credentials * :zap: Remove test data * :arrow_up: Update package-lock.json file * :zap: Remove old not longer used code Co-authored-by: Ben Hesseldieck <b.hesseldieck@gmail.com> Co-authored-by: Mutasem <mutdmour@gmail.com> Co-authored-by: PaulineDropcontact <pauline@dropcontact.io> Co-authored-by: ricardo <ricardoespinoza105@gmail.com>
2022-02-05 13:55:43 -08:00
INodeCredentialTestResult,
INodeExecutionData,
2021-10-17 09:48:24 -07:00
INodePropertyOptions,
INodeType,
INodeTypeDescription,
} from 'n8n-workflow';
import { configOperations } from './ConfigDescription';
import { serviceFields, serviceOperations } from './ServiceDescription';
import { stateFields, stateOperations } from './StateDescription';
import { eventFields, eventOperations } from './EventDescription';
import { logFields, logOperations } from './LogDescription';
import { templateFields, templateOperations } from './TemplateDescription';
import { historyFields, historyOperations } from './HistoryDescription';
import { cameraProxyFields, cameraProxyOperations } from './CameraProxyDescription';
import {
2021-10-17 09:48:24 -07:00
getHomeAssistantEntities,
getHomeAssistantServices,
homeAssistantApiRequest,
} from './GenericFunctions';
export class HomeAssistant implements INodeType {
description: INodeTypeDescription = {
displayName: 'Home Assistant',
name: 'homeAssistant',
icon: 'file:homeAssistant.svg',
group: ['output'],
version: 1,
subtitle: '={{$parameter["operation"] + ": " + $parameter["resource"]}}',
description: 'Consume Home Assistant API',
defaults: {
name: 'Home Assistant',
},
inputs: ['main'],
outputs: ['main'],
credentials: [
{
name: 'homeAssistantApi',
required: true,
2021-10-20 20:35:51 -07:00
testedBy: 'homeAssistantApiTest',
},
],
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: 'Camera Proxy',
value: 'cameraProxy',
},
{
name: 'Config',
value: 'config',
},
{
name: 'Event',
value: 'event',
},
// {
// name: 'History',
// value: 'history',
// },
{
name: 'Log',
value: 'log',
},
{
name: 'Service',
value: 'service',
},
{
name: 'State',
value: 'state',
},
{
name: 'Template',
value: 'template',
},
],
default: 'config',
},
...cameraProxyOperations,
...cameraProxyFields,
...configOperations,
...eventOperations,
...eventFields,
...historyOperations,
...historyFields,
...logOperations,
...logFields,
...serviceOperations,
...serviceFields,
...stateOperations,
...stateFields,
...templateOperations,
...templateFields,
],
};
2021-10-20 20:35:51 -07:00
methods = {
credentialTest: {
async homeAssistantApiTest(
this: ICredentialTestFunctions,
credential: ICredentialsDecrypted,
): Promise<INodeCredentialTestResult> {
2021-10-20 20:35:51 -07:00
const credentials = credential.data;
const options = {
method: 'GET',
headers: {
Authorization: `Bearer ${credentials!.accessToken}`,
},
uri: `${credentials!.ssl === true ? 'https' : 'http'}://${credentials!.host}:${
credentials!.port || '8123'
}/api/`,
2021-10-20 20:35:51 -07:00
json: true,
timeout: 5000,
};
try {
const response = await this.helpers.request(options);
if (!response.message) {
return {
status: 'Error',
message: `Token is not valid: ${response.error}`,
};
}
} catch (error) {
return {
status: 'Error',
message: `${
error.statusCode === 401 ? 'Token is' : 'Settings are'
} not valid: ${error}`,
2021-10-20 20:35:51 -07:00
};
}
return {
status: 'OK',
message: 'Authentication successful!',
};
},
},
2021-10-20 20:35:51 -07:00
2021-10-17 09:48:24 -07:00
loadOptions: {
async getAllEntities(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]> {
return getHomeAssistantEntities.call(this);
2021-10-17 09:48:24 -07:00
},
async getCameraEntities(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]> {
return getHomeAssistantEntities.call(this, 'camera');
2021-10-17 09:48:24 -07:00
},
async getDomains(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]> {
return getHomeAssistantServices.call(this);
2021-10-17 09:48:24 -07:00
},
async getDomainServices(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]> {
const currentDomain = this.getCurrentNodeParameter('domain') as string;
if (currentDomain) {
return getHomeAssistantServices.call(this, currentDomain);
2021-10-17 09:48:24 -07:00
} else {
return [];
}
2021-10-20 20:35:51 -07:00
},
},
};
async execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]> {
const items = this.getInputData();
const returnData: INodeExecutionData[] = [];
const length = items.length;
const resource = this.getNodeParameter('resource', 0);
const operation = this.getNodeParameter('operation', 0);
const qs: IDataObject = {};
let responseData;
for (let i = 0; i < length; i++) {
try {
if (resource === 'config') {
if (operation === 'get') {
responseData = await homeAssistantApiRequest.call(this, 'GET', '/config');
} else if (operation === 'check') {
responseData = await homeAssistantApiRequest.call(
this,
'POST',
'/config/core/check_config',
);
}
} else if (resource === 'service') {
if (operation === 'getAll') {
const returnAll = this.getNodeParameter('returnAll', i);
responseData = (await homeAssistantApiRequest.call(
this,
'GET',
'/services',
)) as IDataObject[];
if (!returnAll) {
const limit = this.getNodeParameter('limit', i);
responseData = responseData.slice(0, limit);
}
} else if (operation === 'call') {
const domain = this.getNodeParameter('domain', i) as string;
const service = this.getNodeParameter('service', i) as string;
const serviceAttributes = this.getNodeParameter('serviceAttributes', i) as {
attributes: IDataObject[];
};
const body: IDataObject = {};
if (Object.entries(serviceAttributes).length) {
if (serviceAttributes.attributes !== undefined) {
serviceAttributes.attributes.map((attribute) => {
// @ts-ignore
body[attribute.name as string] = attribute.value;
});
}
}
responseData = await homeAssistantApiRequest.call(
this,
'POST',
`/services/${domain}/${service}`,
body,
);
if (Array.isArray(responseData) && responseData.length === 0) {
responseData = {};
}
}
} else if (resource === 'state') {
if (operation === 'getAll') {
const returnAll = this.getNodeParameter('returnAll', i);
responseData = (await homeAssistantApiRequest.call(
this,
'GET',
'/states',
)) as IDataObject[];
if (!returnAll) {
const limit = this.getNodeParameter('limit', i);
responseData = responseData.slice(0, limit);
}
} else if (operation === 'get') {
const entityId = this.getNodeParameter('entityId', i) as string;
responseData = await homeAssistantApiRequest.call(this, 'GET', `/states/${entityId}`);
} else if (operation === 'upsert') {
const entityId = this.getNodeParameter('entityId', i) as string;
const state = this.getNodeParameter('state', i) as string;
const stateAttributes = this.getNodeParameter('stateAttributes', i) as {
attributes: IDataObject[];
};
const body = {
state,
attributes: {},
};
if (Object.entries(stateAttributes).length) {
if (stateAttributes.attributes !== undefined) {
stateAttributes.attributes.map((attribute) => {
// @ts-ignore
body.attributes[attribute.name as string] = attribute.value;
});
}
}
responseData = await homeAssistantApiRequest.call(
this,
'POST',
`/states/${entityId}`,
body,
);
}
} else if (resource === 'event') {
if (operation === 'getAll') {
const returnAll = this.getNodeParameter('returnAll', i);
responseData = (await homeAssistantApiRequest.call(
this,
'GET',
'/events',
)) as IDataObject[];
if (!returnAll) {
const limit = this.getNodeParameter('limit', i);
responseData = responseData.slice(0, limit);
}
} else if (operation === 'create') {
const eventType = this.getNodeParameter('eventType', i) as string;
const eventAttributes = this.getNodeParameter('eventAttributes', i) as {
attributes: IDataObject[];
};
const body = {};
if (Object.entries(eventAttributes).length) {
if (eventAttributes.attributes !== undefined) {
eventAttributes.attributes.map((attribute) => {
// @ts-ignore
body[attribute.name as string] = attribute.value;
});
}
}
responseData = await homeAssistantApiRequest.call(
this,
'POST',
`/events/${eventType}`,
body,
);
}
} else if (resource === 'log') {
if (operation === 'getErroLogs') {
responseData = await homeAssistantApiRequest.call(this, 'GET', '/error_log');
if (responseData) {
responseData = {
errorLog: responseData,
};
}
} else if (operation === 'getLogbookEntries') {
const additionalFields = this.getNodeParameter('additionalFields', i);
let endpoint = '/logbook';
if (Object.entries(additionalFields).length) {
if (additionalFields.startTime) {
endpoint = `/logbook/${additionalFields.startTime}`;
}
if (additionalFields.endTime) {
qs.end_time = additionalFields.endTime;
}
if (additionalFields.entityId) {
qs.entity = additionalFields.entityId;
}
}
responseData = await homeAssistantApiRequest.call(this, 'GET', endpoint, {}, qs);
}
} else if (resource === 'template') {
if (operation === 'create') {
const body = {
template: this.getNodeParameter('template', i) as string,
};
responseData = await homeAssistantApiRequest.call(this, 'POST', '/template', body);
if (responseData) {
responseData = { renderedTemplate: responseData };
}
}
} else if (resource === 'history') {
if (operation === 'getAll') {
const returnAll = this.getNodeParameter('returnAll', i);
const additionalFields = this.getNodeParameter('additionalFields', i);
let endpoint = '/history/period';
if (Object.entries(additionalFields).length) {
if (additionalFields.startTime) {
endpoint = `/history/period/${additionalFields.startTime}`;
}
if (additionalFields.endTime) {
qs.end_time = additionalFields.endTime;
}
if (additionalFields.entityIds) {
qs.filter_entity_id = additionalFields.entityIds;
}
if (additionalFields.minimalResponse === true) {
qs.minimal_response = additionalFields.minimalResponse;
}
if (additionalFields.significantChangesOnly === true) {
qs.significant_changes_only = additionalFields.significantChangesOnly;
}
}
responseData = (await homeAssistantApiRequest.call(
this,
'GET',
endpoint,
{},
qs,
)) as IDataObject[];
if (!returnAll) {
const limit = this.getNodeParameter('limit', i);
responseData = responseData.slice(0, limit);
}
}
} else if (resource === 'cameraProxy') {
if (operation === 'getScreenshot') {
const cameraEntityId = this.getNodeParameter('cameraEntityId', i) as string;
const dataPropertyNameDownload = this.getNodeParameter('binaryPropertyName', i);
const endpoint = `/camera_proxy/${cameraEntityId}`;
let mimeType: string | undefined;
responseData = await homeAssistantApiRequest.call(
this,
'GET',
endpoint,
{},
{},
undefined,
{
encoding: null,
resolveWithFullResponse: true,
},
);
const newItem: INodeExecutionData = {
json: items[i].json,
binary: {},
};
if (mimeType === undefined && responseData.headers['content-type']) {
mimeType = responseData.headers['content-type'];
}
if (items[i].binary !== undefined && newItem.binary) {
// Create a shallow copy of the binary data so that the old
// data references which do not get changed still stay behind
// but the incoming data does not get changed.
Object.assign(newItem.binary, items[i].binary);
}
items[i] = newItem;
const data = Buffer.from(responseData.body as string);
items[i].binary![dataPropertyNameDownload] = await this.helpers.prepareBinaryData(
data,
'screenshot.jpg',
mimeType,
);
}
}
} catch (error) {
if (this.continueOnFail()) {
if (resource === 'cameraProxy' && operation === 'get') {
items[i].json = { error: error.message };
} else {
const executionData = this.helpers.constructExecutionMetaData(
this.helpers.returnJsonArray({ error: error.message }),
{ itemData: { item: i } },
);
returnData.push(...executionData);
}
continue;
}
throw error;
}
const executionData = this.helpers.constructExecutionMetaData(
this.helpers.returnJsonArray(responseData as IDataObject[]),
{ itemData: { item: i } },
);
returnData.push(...executionData);
}
if (resource === 'cameraProxy' && operation === 'getScreenshot') {
return this.prepareOutputData(items);
} else {
return this.prepareOutputData(returnData);
}
}
}