virtualdevices.ts

import { Flags } from '@oclif/core'

import {
	Device,
	DeviceIntegrationType,
	DeviceListOptions,
} from '@smartthings/core-sdk'

import {
	APICommand,
	outputItemOrList,
	OutputItemOrListConfig,
	withLocationsAndRooms,
	WithNamedRoom,
} from '@smartthings/cli-lib'

import { buildTableOutput } from '../lib/commands/devices-util'


export default class VirtualDevicesCommand extends APICommand<typeof VirtualDevicesCommand.flags> {
	static description = 'list all virtual devices available in a user account or retrieve a single device'

	static flags = {
		...APICommand.flags,
		...outputItemOrList.flags,
		location: Flags.string({
			char: 'l',
			description: 'filter results by location',
			multiple: true,
			helpValue: '<UUID>',
		}),
		// eslint-disable-next-line @typescript-eslint/naming-convention
		'installed-app': Flags.string({
			char: 'a',
			description: 'filter results by installed app that created the device',
			helpValue: '<UUID>',
		}),
		verbose: Flags.boolean({
			description: 'include location name in output',
			char: 'v',
		}),
	}

	static args = [{
		name: 'id',
		description: 'device to retrieve; UUID or the number of the device from list',
	}]

	async run(): Promise<void> {
		const config: OutputItemOrListConfig<Device & WithNamedRoom> = {
			primaryKeyName: 'deviceId',
			sortKeyName: 'label',
			listTableFieldDefinitions: ['label', 'deviceId'],
			buildTableOutput: (data: Device) => buildTableOutput(this.tableGenerator, data),
		}
		if (this.flags.verbose) {
			config.listTableFieldDefinitions.splice(3, 0, 'location', 'room')
		}

		const deviceListOptions: DeviceListOptions = {
			locationId: this.flags.location,
			installedAppId: this.flags['installed-app'],
			type: DeviceIntegrationType.VIRTUAL,
		}

		await outputItemOrList(this, config, this.args.id,
			async () => {
				const devices = await this.client.devices.list(deviceListOptions)
				if (this.flags.verbose) {
					return await withLocationsAndRooms(this.client, devices)
				}
				return devices
			},
			id => this.client.devices.get(id),
		)
	}
}