Function handler

src/commands/devices.ts:121–181

(argv: ArgumentsCamelCase<CommandArgs>)

export type OutputDevice = Device & WithNamedRoom & Pick<DeviceStatus, 'healthState'>

const handler = async (argv: ArgumentsCamelCase<CommandArgs>): Promise<void> => {
	const command = await apiCommand(argv)

	const listTableFieldDefinitions: TableFieldDefinition<OutputDevice>[] = ['label', 'name', 'type', 'deviceId']

	if (argv.verbose) {
		listTableFieldDefinitions.splice(3, 0, 'location', 'room')
	}

	if (argv.health) {
		listTableFieldDefinitions.splice(3, 0, {
			path: 'healthState.state',
			label: 'Health',
		})
	}

	const config: OutputItemOrListConfig<OutputDevice> = {
		primaryKeyName: 'deviceId',
		sortKeyName: 'label',
		listTableFieldDefinitions,
		buildTableOutput: (data: Device) => buildTableOutput(command.tableGenerator, data),
	}

	const deviceGetOptions: DeviceGetOptions = {
		includeStatus: argv.status,
	}

	const deviceListOptions: DeviceListOptions = {
		capability: argv.capability,
		capabilitiesMode: argv.capabilitiesMode === 'or' ? 'or' : 'and',
		locationId: argv.location,
		deviceId: argv.device,
		installedAppId: argv.installedApp,
		type: argv.type as DeviceIntegrationType[] | undefined,
		includeHealth: argv.health,
		...deviceGetOptions,
	}

	await outputItemOrList<OutputDevice>(command, config, argv.idOrIndex,
		async () => {
			const devices = await command.client.devices.list(deviceListOptions)
			if (argv.verbose) {
				return await withLocationsAndRooms(command.client, devices)
			}
			return devices
		},
		async id => {
			let chosenDevice: OutputDevice = await command.client.devices.get(id, deviceGetOptions)
			if (argv.verbose) {
				chosenDevice = await withLocationAndRoom(command.client, chosenDevice)
			}
			// Note -- we have to do this explicitly because the API does not honor the includeHealth
			// parameter for individual devices
			if (argv.health) {
				const healthState = await command.client.devices.getHealth(id)
				chosenDevice = { ...chosenDevice, healthState }
			}
			return chosenDevice