Add lock and unlock examples (#69)

* Add lock and unlock examples

* Fix type

Author: razor-x

examples/index.ts

@@ -13,6 +13,8 @@ import landlubber, {
 import { Seam } from 'seam'
 
 import * as devices from './devices.js'
+import * as lock from './lock.js'
+import * as unlock from './unlock.js'
 
 export type Handler<Options = EmptyOptions> = DefaultHandler<Options, Context>
 
@@ -22,7 +24,7 @@ interface ClientContext {
   seam: Seam
 }
 
-const commands = [devices]
+const commands = [devices, lock, unlock]
 
 const createAppContext: MiddlewareFunction = async (argv) => {
   const apiKey = argv['api-key']

examples/lock.ts

@@ -0,0 +1,61 @@
+import type { Builder, Command, Describe } from 'landlubber'
+
+import {
+  isSeamActionAttemptFailedError,
+  isSeamActionAttemptTimeoutError,
+  type LocksLockDoorResponse,
+} from 'seam'
+
+import type { Handler } from './index.js'
+
+interface Options {
+  deviceId: string
+}
+
+export const command: Command = 'lock deviceId'
+
+export const describe: Describe = 'Lock a door'
+
+export const builder: Builder = {
+  deviceId: {
+    type: 'string',
+    describe: 'Device id of lock to lock',
+  },
+}
+
+export const handler: Handler<Options> = async ({ deviceId, seam, logger }) => {
+  const device = await seam.devices.get({ device_id: deviceId })
+
+  if (device.can_remotely_lock == null) {
+    throw new Error('This device does not support remote locking')
+  }
+
+  if (!device.can_remotely_lock) {
+    throw new Error('This device cannot be locked at this time')
+  }
+
+  try {
+    const actionAttempt = await seam.locks.lockDoor(
+      {
+        device_id: deviceId,
+      },
+      { waitForActionAttempt: true },
+    )
+    logger.info({ actionAttempt }, 'locked')
+  } catch (err: unknown) {
+    if (isSeamActionAttemptFailedError<LockDoorActionAttempt>(err)) {
+      logger.info({ err }, 'Could not unlock the door')
+      return
+    }
+
+    if (isSeamActionAttemptTimeoutError<LockDoorActionAttempt>(err)) {
+      logger.info({ err }, 'Door took too long to unlock')
+      return
+    }
+
+    throw err
+  }
+}
+
+// TODO: import type { LockDoorActionAttempt } from 'seam'
+type LockDoorActionAttempt = LocksLockDoorResponse['action_attempt']

examples/unlock.ts

@@ -0,0 +1,61 @@
+import type { Builder, Command, Describe } from 'landlubber'
+
+import {
+  isSeamActionAttemptFailedError,
+  isSeamActionAttemptTimeoutError,
+  type LocksUnlockDoorResponse,
+} from 'seam'
+
+import type { Handler } from './index.js'
+
+interface Options {
+  deviceId: string
+}
+
+export const command: Command = 'unlock deviceId'
+
+export const describe: Describe = 'Unlock a door'
+
+export const builder: Builder = {
+  deviceId: {
+    type: 'string',
+    describe: 'Device id of lock to unlock',
+  },
+}
+
+export const handler: Handler<Options> = async ({ deviceId, seam, logger }) => {
+  const device = await seam.devices.get({ device_id: deviceId })
+
+  if (device.can_remotely_unlock == null) {
+    throw new Error('This device does not support remote unlocking')
+  }
+
+  if (!device.can_remotely_unlock) {
+    throw new Error('This device cannot be unlocked at this time')
+  }
+
+  try {
+    const actionAttempt = await seam.locks.unlockDoor(
+      {
+        device_id: deviceId,
+      },
+      { waitForActionAttempt: true },
+    )
+    logger.info({ actionAttempt }, 'unlocked')
+  } catch (err: unknown) {
+    if (isSeamActionAttemptFailedError<UnlockDoorActionAttempt>(err)) {
+      logger.info({ err }, 'Could not unlock the door')
+      return
+    }
+
+    if (isSeamActionAttemptTimeoutError<UnlockDoorActionAttempt>(err)) {
+      logger.info({ err }, 'Door took too long to unlock')
+      return
+    }
+
+    throw err
+  }
+}
+
+// TODO: import type { UnlockDoorActionAttempt } from 'seam'
+type UnlockDoorActionAttempt = LocksUnlockDoorResponse['action_attempt']