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

187 lines
4.8 KiB
TypeScript
Raw Normal View History

import type {
IDataObject,
IExecuteFunctions,
2020-07-31 13:26:23 -07:00
ILoadOptionsFunctions,
INodeExecutionData,
2020-07-31 13:26:23 -07:00
INodePropertyOptions,
INodeType,
INodeTypeDescription,
2020-07-31 13:26:23 -07:00
} from 'n8n-workflow';
import { getUser, philipsHueApiRequest } from './GenericFunctions';
2020-07-31 13:26:23 -07:00
import { lightFields, lightOperations } from './LightDescription';
2020-07-31 13:26:23 -07:00
2020-08-03 01:06:46 -07:00
export class PhilipsHue implements INodeType {
2020-07-31 13:26:23 -07:00
description: INodeTypeDescription = {
2020-08-03 01:06:46 -07:00
displayName: 'Philips Hue',
name: 'philipsHue',
refactor: Apply more `eslint-plugin-n8n-nodes-base` rules (#3534) * :zap: Update `lintfix` script * :zap: Run baseline `lintfix` * :fire: Remove unneeded exceptions (#3538) * :fire: Remove exceptions for `node-param-default-wrong-for-simplify` * :fire: Remove exceptions for `node-param-placeholder-miscased-id` * :zap: Update version * :shirt: Apply `node-param-placeholder-missing` (#3542) * :shirt: Apply `filesystem-wrong-cred-filename` (#3543) * :shirt: Apply `node-param-description-missing-from-dynamic-options` (#3545) Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Apply `node-class-description-empty-string` (#3546) * :shirt: Apply `node-class-description-icon-not-svg` (#3548) * :shirt: Apply `filesystem-wrong-node-filename` (#3549) Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Expand lintings to credentials (#3550) * :shirt: Apply `node-param-multi-options-type-unsorted-items` (#3552) * :zap: fix * :zap: Minor fixes Co-authored-by: Michael Kret <michael.k@radency.com> * :shirt: Apply `node-param-description-wrong-for-dynamic-multi-options` (#3541) * :zap: Add new lint rule, node-param-description-wrong-for-dynamic-multi-options * :zap: Fix with updated linting rules * :zap: Minor fixes Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Apply `node-param-description-boolean-without-whether` (#3553) * :zap: fix * Update packages/nodes-base/nodes/Clockify/ProjectDescription.ts Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Apply node-param-display-name-wrong-for-dynamic-multi-options (#3537) * :shirt: Add exceptions * :shirt: Add exception * :pencil2: Alphabetize rules * :zap: Restore `lintfix` command Co-authored-by: agobrech <45268029+agobrech@users.noreply.github.com> Co-authored-by: Omar Ajoue <krynble@gmail.com> Co-authored-by: Michael Kret <michael.k@radency.com> Co-authored-by: brianinoa <54530642+brianinoa@users.noreply.github.com> Co-authored-by: Michael Kret <88898367+michael-radency@users.noreply.github.com>
2022-06-20 07:54:01 -07:00
// eslint-disable-next-line n8n-nodes-base/node-class-description-icon-not-svg
2020-08-03 01:06:46 -07:00
icon: 'file:philipshue.png',
2020-07-31 13:26:23 -07:00
group: ['input'],
version: 1,
subtitle: '={{$parameter["operation"] + ": " + $parameter["resource"]}}',
description: 'Consume Philips Hue API',
2020-07-31 13:26:23 -07:00
defaults: {
2020-08-03 01:06:46 -07:00
name: 'Philips Hue',
2020-07-31 13:26:23 -07:00
},
inputs: ['main'],
outputs: ['main'],
credentials: [
{
2020-08-03 01:06:46 -07:00
name: 'philipsHueOAuth2Api',
2020-07-31 13:26:23 -07:00
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,
2020-07-31 13:26:23 -07:00
options: [
{
name: 'Light',
value: 'light',
},
],
default: 'light',
},
...lightOperations,
...lightFields,
],
};
methods = {
loadOptions: {
// Get all the lights to display them to user so that he can
// select them easily
async getLights(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]> {
2020-07-31 13:26:23 -07:00
const returnData: INodePropertyOptions[] = [];
const user = await getUser.call(this);
const lights = await philipsHueApiRequest.call(this, 'GET', `/api/${user}/lights`);
const groups = await philipsHueApiRequest.call(this, 'GET', `/api/${user}/groups`);
for (const light of Object.keys(lights as IDataObject)) {
let lightName = lights[light].name;
2020-07-31 13:26:23 -07:00
const lightId = light;
for (const groupId of Object.keys(groups as IDataObject)) {
if (groups[groupId].type === 'Room' && groups[groupId].lights.includes(lightId)) {
lightName = `${groups[groupId].name}: ${lightName}`;
}
}
2020-07-31 13:26:23 -07:00
returnData.push({
name: lightName,
2020-10-22 06:46:03 -07:00
value: lightId,
2020-07-31 13:26:23 -07:00
});
}
return returnData;
},
2020-10-22 06:46:03 -07:00
},
2020-07-31 13:26:23 -07:00
};
async execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]> {
const items = this.getInputData();
const returnData: INodeExecutionData[] = [];
refactor: Apply `eslint-plugin-n8n-nodes-base` autofixable rules (#3174) * :zap: Initial setup * :shirt: Update `.eslintignore` * :shirt: Autofix node-param-default-missing (#3173) * :fire: Remove duplicate key * :shirt: Add exceptions * :package: Update package-lock.json * :shirt: Apply `node-class-description-inputs-wrong-trigger-node` (#3176) * :shirt: Apply `node-class-description-inputs-wrong-regular-node` (#3177) * :shirt: Apply `node-class-description-outputs-wrong` (#3178) * :shirt: Apply `node-execute-block-double-assertion-for-items` (#3179) * :shirt: Apply `node-param-default-wrong-for-collection` (#3180) * :shirt: Apply node-param-default-wrong-for-boolean (#3181) * Autofixed default missing * Autofixed booleans, worked well * :zap: Fix params * :rewind: Undo exempted autofixes * :package: Update package-lock.json * :shirt: Apply node-class-description-missing-subtitle (#3182) * :zap: Fix missing comma * :shirt: Apply `node-param-default-wrong-for-fixed-collection` (#3184) * :shirt: Add exception for `node-class-description-missing-subtitle` * :shirt: Apply `node-param-default-wrong-for-multi-options` (#3185) * :shirt: Apply `node-param-collection-type-unsorted-items` (#3186) * Missing coma * :shirt: Apply `node-param-default-wrong-for-simplify` (#3187) * :shirt: Apply `node-param-description-comma-separated-hyphen` (#3190) * :shirt: Apply `node-param-description-empty-string` (#3189) * :shirt: Apply `node-param-description-excess-inner-whitespace` (#3191) * Rule looks good * Add whitespace rule in eslint config * :zao: fix * :shirt: Apply `node-param-description-identical-to-display-name` (#3193) * :shirt: Apply `node-param-description-missing-for-ignore-ssl-issues` (#3195) * :rewind: Revert ":zao: fix" This reverts commit ef8a76f3dfedffd1bdccf3178af8a8d90cf5a55c. * :shirt: Apply `node-param-description-missing-for-simplify` (#3196) * :shirt: Apply `node-param-description-missing-final-period` (#3194) * Rule working as intended * Add rule to eslint * :shirt: Apply node-param-description-missing-for-return-all (#3197) * :zap: Restore `lintfix` command Co-authored-by: agobrech <45268029+agobrech@users.noreply.github.com> Co-authored-by: Omar Ajoue <krynble@gmail.com> Co-authored-by: agobrech <ael.gobrecht@gmail.com> Co-authored-by: Michael Kret <michael.k@radency.com>
2022-04-22 09:29:51 -07:00
const length = items.length;
2020-07-31 13:26:23 -07:00
let responseData;
const resource = this.getNodeParameter('resource', 0);
const operation = this.getNodeParameter('operation', 0);
2020-07-31 13:26:23 -07:00
for (let i = 0; i < length; i++) {
if (resource === 'light') {
if (operation === 'update') {
const lightId = this.getNodeParameter('lightId', i) as string;
const on = this.getNodeParameter('on', i) as boolean;
const additionalFields = this.getNodeParameter('additionalFields', i);
2020-07-31 13:26:23 -07:00
const body = {
on,
};
if (additionalFields.transitiontime) {
additionalFields.transitiontime = (additionalFields.transitiontime as number) * 100;
2020-07-31 13:26:23 -07:00
}
if (additionalFields.xy) {
additionalFields.xy = (additionalFields.xy as string)
.split(',')
.map((e: string) => parseFloat(e));
2020-07-31 13:26:23 -07:00
}
if (additionalFields.xy_inc) {
additionalFields.xy_inc = (additionalFields.xy_inc as string)
.split(',')
.map((e: string) => parseFloat(e));
2020-07-31 13:26:23 -07:00
}
Object.assign(body, additionalFields);
const user = await getUser.call(this);
2020-08-03 01:06:46 -07:00
const data = await philipsHueApiRequest.call(
2020-07-31 13:26:23 -07:00
this,
'PUT',
`/api/${user}/lights/${lightId}/state`,
2020-10-22 09:00:28 -07:00
body,
2020-07-31 13:26:23 -07:00
);
responseData = {};
for (const response of data) {
Object.assign(responseData, response.success);
}
}
if (operation === 'delete') {
const lightId = this.getNodeParameter('lightId', i) as string;
const user = await getUser.call(this);
responseData = await philipsHueApiRequest.call(
this,
'DELETE',
`/api/${user}/lights/${lightId}`,
);
2020-07-31 13:26:23 -07:00
}
if (operation === 'getAll') {
const returnAll = this.getNodeParameter('returnAll', i);
2020-07-31 13:26:23 -07:00
const user = await getUser.call(this);
const lights = await philipsHueApiRequest.call(this, 'GET', `/api/${user}/lights`);
2020-07-31 13:26:23 -07:00
responseData = Object.values(lights as IDataObject);
2020-07-31 13:26:23 -07:00
if (!returnAll) {
const limit = this.getNodeParameter('limit', i);
2020-07-31 13:26:23 -07:00
responseData = responseData.splice(0, limit);
}
}
if (operation === 'get') {
const lightId = this.getNodeParameter('lightId', i) as string;
const user = await getUser.call(this);
responseData = await philipsHueApiRequest.call(
this,
'GET',
`/api/${user}/lights/${lightId}`,
);
2020-07-31 13:26:23 -07:00
}
}
const executionData = this.helpers.constructExecutionMetaData(
this.helpers.returnJsonArray(responseData as IDataObject[]),
{ itemData: { item: i } },
);
returnData.push(...executionData);
2020-07-31 13:26:23 -07:00
}
return this.prepareOutputData(returnData);
2020-07-31 13:26:23 -07:00
}
}