feat(cli): list devices

Author: coderbyheart

cli/cli.ts

@@ -18,6 +18,7 @@ import { logsCommand } from './commands/logs.js'
 import { CloudWatchLogsClient } from '@aws-sdk/client-cloudwatch-logs'
 import { configureHello } from './commands/configure-hello.js'
 import { shareDevice } from './commands/share-device.js'
+import { listDevicesCommand } from './commands/listDevices.js'
 
 const ssm = new SSMClient({})
 const db = new DynamoDBClient({})
@@ -79,6 +80,10 @@ const CLI = async ({ isCI }: { isCI: boolean }) => {
 					publicDevicesTableName: backendOutputs.publicDevicesTableName,
 					idIndex: backendOutputs.publicDevicesTableIdIndexName,
 				}),
+				listDevicesCommand({
+					db,
+					publicDevicesTableName: backendOutputs.publicDevicesTableName,
+				}),
 			)
 		} catch (error) {
 			console.warn(chalk.yellow('⚠️'), chalk.yellow((error as Error).message))

cli/commands/listDevices.ts

@@ -0,0 +1,55 @@
+import { ScanCommand, type DynamoDBClient } from '@aws-sdk/client-dynamodb'
+import { unmarshall } from '@aws-sdk/util-dynamodb'
+import type { CommandDefinition } from './CommandDefinition.js'
+import { table } from 'table'
+import chalk from 'chalk'
+
+export const listDevicesCommand = ({
+	db,
+	publicDevicesTableName,
+}: {
+	db: DynamoDBClient
+	publicDevicesTableName: string
+}): CommandDefinition => ({
+	command: 'list-devices',
+	options: [
+		{
+			flags: '-n, --nextKey <key>',
+			description: `Pagination key`,
+		},
+	],
+	action: async ({ nextKey }) => {
+		const { Items, LastEvaluatedKey } = await db.send(
+			new ScanCommand({
+				TableName: publicDevicesTableName,
+				Limit: 100,
+				ExclusiveStartKey:
+					nextKey !== undefined
+						? JSON.parse(Buffer.from(nextKey, 'base64').toString())
+						: undefined,
+			}),
+		)
+
+		console.log(
+			table([
+				['Device ID', 'Public ID', 'Model', 'Owner Email', 'Confirmed until'],
+				...(Items ?? [])
+					.map((i) => unmarshall(i))
+					.map(({ secret__deviceId: deviceId, id, model, ownerEmail, ttl }) => [
+						chalk.green(deviceId),
+						chalk.blue(id),
+						model,
+						ownerEmail,
+						new Date(ttl * 1000).toISOString(),
+					]),
+			]),
+		)
+
+		console.log(
+			LastEvaluatedKey
+				? `More devices available: ${Buffer.from(JSON.stringify(LastEvaluatedKey)).toString('base64')}`
+				: 'No more devices',
+		)
+	},
+	help: 'List public devices',
+})

package-lock.json

@@ -59,6 +59,7 @@
     "husky": "9.0.11",
     "jsonata": "2.0.5",
     "semver": "7.6.2",
+    "table": "6.8.2",
     "tsmatchers": "5.0.2",
     "tsx": "4.16.2"
   },