✨ Add loadOptions for Home Assistant

packages/nodes-base/nodes/HomeAssistant/CameraProxyDescription.ts

@@ -33,7 +33,10 @@ export const cameraProxyFields = [
 	{
 		displayName: 'Camera Entity ID',
 		name: 'cameraEntityId',
-		type: 'string',
+		type: 'options',
+		typeOptions: {
+			loadOptionsMethod: 'getCameraEntities',
+		},
 		default: '',
 		required: true,
 		displayOptions: {

packages/nodes-base/nodes/HomeAssistant/GenericFunctions.ts

@@ -4,15 +4,17 @@ import {
 
 import {
 	IExecuteFunctions,
+	ILoadOptionsFunctions,
 } from 'n8n-core';
 
 import {
 	IDataObject,
+	INodePropertyOptions,
 	NodeApiError,
 	NodeOperationError,
 } from 'n8n-workflow';
 
-export async function homeAssistantApiRequest(this: IExecuteFunctions, method: string, resource: string, body: IDataObject = {}, qs: IDataObject = {}, uri?: string, option: IDataObject = {}) {
+export async function homeAssistantApiRequest(this: IExecuteFunctions | ILoadOptionsFunctions, method: string, resource: string, body: IDataObject = {}, qs: IDataObject = {}, uri?: string, option: IDataObject = {}) {
 	const credentials = await this.getCredentials('homeAssistantApi');
 
 	if (credentials === undefined) {
@@ -35,8 +37,51 @@ export async function homeAssistantApiRequest(this: IExecuteFunctions, method: s
 		delete options.body;
 	}
 	try {
+		if (this.helpers.request) {
 			return await this.helpers.request(options);
+		}
 	} catch (error) {
 		throw new NodeApiError(this.getNode(), error);
 	}
 }
+
+export async function getHomeAssistantEntities(this: IExecuteFunctions | ILoadOptionsFunctions, domain = '') {
+	const returnData: INodePropertyOptions[] = [];
+	const entities = await homeAssistantApiRequest.call(this, 'GET', '/states');
+	for (const entity of entities) {
+		const entityId = entity.entity_id as string;
+		if (domain === '' || domain && entityId.startsWith(domain)) {
+			const entityName = entity.attributes.friendly_name as string || entityId;
+			returnData.push({
+				name: entityName,
+				value: entityId,
+			});
+		}
+	}
+	return returnData;
+}
+
+export async function getHomeAssistantServices(this: IExecuteFunctions | ILoadOptionsFunctions, domain = '') {
+	const returnData: INodePropertyOptions[] = [];
+	const services = await homeAssistantApiRequest.call(this, 'GET', '/services');
+	if (domain === '') {
+		// If no domain specified return domains
+		const domains = services.map(({ domain }: IDataObject) => domain as string).sort();
+		returnData.push(...domains.map((service: string) => ({ name: service, value: service })));
+		return returnData;
+	} else {
+		// If we have a domain, return all relevant services
+		const domainServices = services.filter((service: IDataObject) => service.domain === domain);
+		for (const domainService of domainServices) {
+			for (const [serviceID, value] of Object.entries(domainService.services)) {
+				const serviceProperties = value as IDataObject;
+				const serviceName = serviceProperties.description || serviceID;
+				returnData.push({
+					name: serviceName as string,
+					value: serviceID,
+				});
+			}
+		}
+	}
+	return returnData;
+}

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

@@ -4,7 +4,9 @@ import {
 
 import {
 	IDataObject,
+	ILoadOptionsFunctions,
 	INodeExecutionData,
+	INodePropertyOptions,
 	INodeType,
 	INodeTypeDescription,
 } from 'n8n-workflow';
@@ -49,6 +51,8 @@ import {
 } from './CameraProxyDescription';
 
 import {
+	getHomeAssistantEntities,
+	getHomeAssistantServices,
 	homeAssistantApiRequest,
 } from './GenericFunctions';
 
@@ -133,6 +137,28 @@ export class HomeAssistant implements INodeType {
 		],
 	};
 
+	methods = {
+		loadOptions: {
+			async getAllEntities(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]> {
+				return await getHomeAssistantEntities.call(this);
+			},
+			async getCameraEntities(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]> {
+				return await getHomeAssistantEntities.call(this, 'camera');
+			},
+			async getDomains(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]> {
+				return await getHomeAssistantServices.call(this);
+			},
+			async getDomainServices(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]> {
+				const currentDomain = this.getCurrentNodeParameter('domain') as string;
+				if (currentDomain) {
+					return await getHomeAssistantServices.call(this, currentDomain);
+				} else {
+					return [];
+				}
+			},
+		},
+	};
+
 	async execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]> {
 		const items = this.getInputData();
 		const returnData: IDataObject[] = [];

packages/nodes-base/nodes/HomeAssistant/ServiceDescription.ts

@@ -83,7 +83,10 @@ export const serviceFields = [
 	{
 		displayName: 'Domain',
 		name: 'domain',
-		type: 'string',
+		type: 'options',
+		typeOptions: {
+			loadOptionsMethod: 'getDomains',
+		},
 		default: '',
 		required: true,
 		displayOptions: {
@@ -100,7 +103,13 @@ export const serviceFields = [
 	{
 		displayName: 'Service',
 		name: 'service',
-		type: 'string',
+		type: 'options',
+		typeOptions: {
+			loadOptionsDependsOn: [
+				'domain',
+			],
+			loadOptionsMethod: 'getDomainServices',
+		},
 		default: '',
 		required: true,
 		displayOptions: {

packages/nodes-base/nodes/HomeAssistant/StateDescription.ts

@@ -43,7 +43,10 @@ export const stateFields = [
 	{
 		displayName: 'Entity ID',
 		name: 'entityId',
-		type: 'string',
+		type: 'options',
+		typeOptions: {
+			loadOptionsMethod: 'getAllEntities',
+		},
 		displayOptions: {
 			show: {
 				operation: [
@@ -110,7 +113,10 @@ export const stateFields = [
 	{
 		displayName: 'Entity ID',
 		name: 'entityId',
-		type: 'string',
+		type: 'options',
+		typeOptions: {
+			loadOptionsMethod: 'getAllEntities',
+		},
 		displayOptions: {
 			show: {
 				operation: [