update.ts

import { ActionFunction, APIOrganizationCommand, inputAndOutputItem } from '@smartthings/cli-lib'

import { generateDefaultConfig } from '../../../lib/commands/deviceprofiles/create-util'
import { buildTableOutput, DeviceDefinition, DeviceDefinitionRequest } from '../../../lib/commands/deviceprofiles-util'
import {
	augmentPresentation,
	prunePresentation,
} from '../../../lib/commands/deviceprofiles/view-util'
import { chooseDeviceProfile, cleanupForUpdate } from '../../../lib/commands/deviceprofiles-util'


export default class DeviceProfilesViewUpdateCommand extends APIOrganizationCommand<typeof DeviceProfilesViewUpdateCommand.flags> {
	static description = 'update a device profile and configuration\n' +
		'Updates a device profile and device configuration and sets the vid of the profile ' +
		'to the vid of the updated configuration. Unlike deviceprofiles:update this ' +
		'command accepts a consolidated object that can include a device configuration ' +
		'in a property named "view".' +
		this.apiDocsURL('createDeviceConfiguration', 'updateDeviceProfile', 'generateDeviceConfig')

	static examples = [
		'$ smartthings deviceprofiles:view:update 84042863-0d34-4c5c-b497-808daf230787 -i test.json',
		'',
		'This test.json file adds the powerMeter capability to the device and makes it available in',
		'the device detail view but not the rule builder:',
		'',
		'components:',
		'  - id: main',
		'    capabilities:',
		'      - id: switch',
		'      - id: powerMeter',
		'view:',
		'  dashboard:',
		'    states:',
		'      - capability: switch',
		'    actions:',
		'      - capability: switch',
		'  detailView:',
		'    - capability: switch',
		'    - capability: powerMeter',
		'  automation:',
		'    conditions:',
		'      - capability: switch  ',
	]

	static flags = {
		...APIOrganizationCommand.flags,
		...inputAndOutputItem.flags,
	}

	static args = [{
		name: 'id',
		description: 'device profile id',
	}]

	async run(): Promise<void> {
		const id = await chooseDeviceProfile(this, this.args.id)
		const executeUpdate: ActionFunction<void, DeviceDefinitionRequest, DeviceDefinition> = async (_, data) => {
			const profileData = { ...data }
			delete profileData.view

			const presentationData = data.view
				? augmentPresentation(data.view)
				: await generateDefaultConfig(this.client, id, profileData)

			const presentation = await this.client.presentation.create(presentationData)
			if (!profileData.metadata) {
				profileData.metadata = {}
			}
			profileData.metadata.vid = presentation.presentationId
			profileData.metadata.mnmn = presentation.manufacturerName
			const profile = await this.client.deviceProfiles.update(id, cleanupForUpdate(profileData))

			return { ...profile, presentation: prunePresentation(presentation) }
		}
		await inputAndOutputItem(this, {
			buildTableOutput: data => buildTableOutput(this.tableGenerator, data, { includeViewInfo: true }),
		}, executeUpdate)
	}
}