Skip to content
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import { useState } from 'react'

import { useDevice } from 'lib/seam/devices/use-device.js'
import { isLockDevice, type LockDevice } from 'lib/seam/locks/lock-device.js'
import { isLockDevice, type LockDevice } from 'lib/seam/locks/is-lock-device.js'
import { useToggleLock } from 'lib/seam/locks/use-toggle-lock.js'
import { Button } from 'lib/ui/Button.js'
import { DeviceImage } from 'lib/ui/device/DeviceImage.js'
Expand Down
2 changes: 1 addition & 1 deletion src/lib/seam/components/DeviceDetails/DeviceDetails.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import { NoiseSensorDeviceDetails } from 'lib/seam/components/DeviceDetails/Nois
import { ThermostatDeviceDetails } from 'lib/seam/components/DeviceDetails/ThermostatDeviceDetails.js'
import { useDevice } from 'lib/seam/devices/use-device.js'
import { useUpdateDeviceName } from 'lib/seam/devices/use-update-device-name.js'
import { isLockDevice } from 'lib/seam/locks/lock-device.js'
import { isLockDevice } from 'lib/seam/locks/is-lock-device.js'
import { isNoiseSensorDevice } from 'lib/seam/noise-sensors/noise-sensor-device.js'
import { isThermostatDevice } from 'lib/seam/thermostats/thermostat-device.js'
import { useComponentTelemetry } from 'lib/telemetry/index.js'
Expand Down
52 changes: 8 additions & 44 deletions src/lib/seam/components/DeviceDetails/LockDeviceDetails.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,10 @@ import { NestedAccessCodeTable } from 'lib/seam/components/AccessCodeTable/Acces
import type { NestedSpecificDeviceDetailsProps } from 'lib/seam/components/DeviceDetails/DeviceDetails.js'
import { DeviceInfo } from 'lib/seam/components/DeviceDetails/DeviceInfo.js'
import { DeviceModel } from 'lib/seam/components/DeviceDetails/DeviceModel.js'
import { LockDeviceLockButtons } from 'lib/seam/components/DeviceDetails/LockDeviceLockButtons.js'
import { deviceErrorFilter, deviceWarningFilter } from 'lib/seam/filters.js'
import type { LockDevice } from 'lib/seam/locks/lock-device.js'
import { useToggleLock } from 'lib/seam/locks/use-toggle-lock.js'
import type { LockDevice } from 'lib/seam/locks/is-lock-device.js'
import { Alerts } from 'lib/ui/Alert/Alerts.js'
import { Button } from 'lib/ui/Button.js'
import { BatteryStatusIndicator } from 'lib/ui/device/BatteryStatusIndicator.js'
import { DeviceImage } from 'lib/ui/device/DeviceImage.js'
import { EditableDeviceName } from 'lib/ui/device/EditableDeviceName.js'
Expand Down Expand Up @@ -48,20 +47,6 @@ export function LockDeviceDetails({
const [snackbarVariant, setSnackbarVariant] =
useState<SnackbarVariant>('success')

const toggleLock = useToggleLock({
onSuccess: () => {
setSnackbarVisible(true)
setSnackbarVariant('success')
},
onError: () => {
setSnackbarVisible(true)
setSnackbarVariant('error')
},
})

const lockStatus = device.properties.locked ? t.locked : t.unlocked
const toggleLockLabel = device.properties.locked ? t.unlock : t.lock

const accessCodeCount = accessCodes?.length

if (accessCodes == null) {
Expand Down Expand Up @@ -163,28 +148,12 @@ export function LockDeviceDetails({
</div>

<div className='seam-box'>
{device.properties.locked && device.properties.online && (
<div className='seam-content seam-lock-status'>
<div>
<span className='seam-label'>{t.lockStatus}</span>
<span className='seam-value'>{lockStatus}</span>
</div>
<div className='seam-right'>
{!disableLockUnlock &&
device.capabilities_supported.includes('lock') && (
<Button
size='small'
onClick={() => {
toggleLock.mutate(device)
}}
>
{toggleLockLabel}
</Button>
)}
</div>
</div>
)}

<LockDeviceLockButtons
setSnackbarVisible={setSnackbarVisible}
setSnackbarVariant={setSnackbarVariant}
device={device}
disableLockUnlock={disableLockUnlock}
/>
<AccessCodeLength
supportedCodeLengths={
device.properties?.supported_code_lengths ?? []
Expand Down Expand Up @@ -230,14 +199,9 @@ function AccessCodeLength(props: {

const t = {
device: 'Device',
unlock: 'Unlock',
lock: 'Lock',
locked: 'Locked',
unlocked: 'Unlocked',
accessCodes: 'access codes',
codeLength: 'Code length',
digits: 'digits',
lockStatus: 'Lock status',
status: 'Status',
power: 'Power',
successfullyUpdated: 'Lock status has been successfully updated',
Expand Down
166 changes: 166 additions & 0 deletions src/lib/seam/components/DeviceDetails/LockDeviceLockButtons.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,166 @@
import type { LockDevice } from 'lib/seam/locks/is-lock-device.js'
import { useLock } from 'lib/seam/locks/use-lock.js'
import { useToggleLock } from 'lib/seam/locks/use-toggle-lock.js'
import { useUnlock } from 'lib/seam/locks/use-unlock.js'
import { Button } from 'lib/ui/Button.js'
import type { SnackbarVariant } from 'lib/ui/Snackbar/Snackbar.js'

interface LockDeviceLockButtonsProps {
device: LockDevice
disableLockUnlock: boolean
setSnackbarVisible: (visible: boolean) => void
setSnackbarVariant: (variant: SnackbarVariant) => void
}

export function LockDeviceLockButtons({
device,
setSnackbarVariant,
setSnackbarVisible,
disableLockUnlock,
}: LockDeviceLockButtonsProps): JSX.Element | null {
const lockStatus = device.properties.locked ? t.locked : t.unlocked
const toggleLockLabel = device.properties.locked ? t.unlock : t.lock

const toggleLock = useToggleLock({
onSuccess: () => {
setSnackbarVisible(true)
setSnackbarVariant('success')
},
onError: () => {
setSnackbarVisible(true)
setSnackbarVariant('error')
},
})

const lock = useLock({
onSuccess: () => {
setSnackbarVisible(true)
setSnackbarVariant('success')
},
onError: () => {
setSnackbarVisible(true)
setSnackbarVariant('error')
},
})

const unlock = useUnlock({
onSuccess: () => {
setSnackbarVisible(true)
setSnackbarVariant('success')
},
onError: () => {
setSnackbarVisible(true)
setSnackbarVariant('error')
},
})

if (!device.properties.online) {
return null
}

if (disableLockUnlock) {
return null
}

if (
device.can_remotely_lock === true &&
device.can_remotely_unlock === true
) {
return (
<div className='seam-content seam-lock-status'>
<div>
<span className='seam-label'>{t.lockStatus}</span>
<span className='seam-value'>{lockStatus}</span>
</div>
<div className='seam-right'>
<Button
size='small'
onClick={() => {
toggleLock.mutate(device)
}}
>
{toggleLockLabel}
</Button>
</div>
</div>
)
}

if (device.can_remotely_lock === true) {
return (
<div className='seam-content seam-lock-status'>
<div>
<span className='seam-label'>{t.lockStatus}</span>
<span className='seam-value'>{lockStatus}</span>
</div>
<div className='seam-right'>
<Button
size='small'
onClick={() => {
lock.mutate(device)
}}
>
{t.lock}
</Button>
</div>
</div>
)
}

if (device.can_remotely_unlock === true) {
return (
<div className='seam-content seam-lock-status'>
<div>
<span className='seam-label'>{t.lockStatus}</span>
<span className='seam-value'>{lockStatus}</span>
</div>
<div className='seam-right'>
<Button
size='small'
onClick={() => {
unlock.mutate(device)
}}
>
{t.unlock}
</Button>
</div>
</div>
)
}

return (
<div className='seam-content seam-lock-status'>
<div>
<span className='seam-label'>{t.lockStatus}</span>
<span className='seam-value'>{t.statusUnknown}</span>
</div>
<div className='seam-right'>
<Button
size='small'
onClick={() => {
lock.mutate(device)
}}
>
{t.lock}
</Button>
<Button
size='small'
onClick={() => {
unlock.mutate(device)
}}
>
{t.unlock}
</Button>
</div>
</div>
)
}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For this last condition

Cannot lock or unlock = show unknown status + both lock/unlock buttons

We should not show ANY buttons or any row. If cannot lock or unlock then the buttons are not going to work.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

makes sense, thanks!


const t = {
unlock: 'Unlock',
lock: 'Lock',
locked: 'Locked',
unlocked: 'Unlocked',
lockStatus: 'Lock status',
statusUnknown: 'Unknown',
}
2 changes: 1 addition & 1 deletion src/lib/seam/components/DeviceTable/DeviceTable.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ import {
} from 'lib/seam/components/DeviceTable/DeviceHealthBar.js'
import { DeviceRow } from 'lib/seam/components/DeviceTable/DeviceRow.js'
import { useDevices } from 'lib/seam/devices/use-devices.js'
import { isLockDevice } from 'lib/seam/locks/lock-device.js'
import { isLockDevice } from 'lib/seam/locks/is-lock-device.js'
import { isNoiseSensorDevice } from 'lib/seam/noise-sensors/noise-sensor-device.js'
import { isThermostatDevice } from 'lib/seam/thermostats/thermostat-device.js'
import { useComponentTelemetry } from 'lib/telemetry/index.js'
Expand Down
File renamed without changes.
101 changes: 101 additions & 0 deletions src/lib/seam/locks/use-lock.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,101 @@
import type {
SeamActionAttemptFailedError,
SeamActionAttemptTimeoutError,
SeamHttpApiError,
} from '@seamapi/http/connect'
import { NullSeamClientError, useSeamClient } from '@seamapi/react-query'
import type { ActionAttempt, Device } from '@seamapi/types/connect'
import {
useMutation,
type UseMutationResult,
useQueryClient,
} from '@tanstack/react-query'

export type UseLockData = undefined

export type UseLockMutationVariables = Pick<Device, 'device_id'> & {
properties: Required<Pick<Device['properties'], 'locked'>>
}

type LockActionAttempt = Extract<ActionAttempt, { action_type: 'LOCK_DOOR' }>

type MutationError =
| SeamHttpApiError
| SeamActionAttemptFailedError<LockActionAttempt>
| SeamActionAttemptTimeoutError<LockActionAttempt>

interface UseLockParams {
onError?: () => void
onSuccess?: () => void
}

export function useLock(
params: UseLockParams = {}
): UseMutationResult<UseLockData, MutationError, UseLockMutationVariables> {
const { client } = useSeamClient()
const queryClient = useQueryClient()

return useMutation<UseLockData, MutationError, UseLockMutationVariables>({
mutationFn: async (variables) => {
const {
device_id: deviceId,
properties: { locked },
} = variables
if (client === null) throw new NullSeamClientError()
if (locked == null) return
await client.locks.lockDoor({ device_id: deviceId })
},
onMutate: (variables) => {
queryClient.setQueryData<Device[]>(['devices', 'list', {}], (devices) => {
if (devices == null) {
return devices
}

return devices.map((device) => {
if (
device.device_id !== variables.device_id ||
device.properties.locked == null
) {
return device
}

return {
...device,
properties: {
...device.properties,
locked: !variables.properties.locked,
},
}
})
})

queryClient.setQueryData<Device>(
['devices', 'get', { device_id: variables.device_id }],
(device) => {
if (device?.properties.locked == null) return device

return {
...device,
properties: {
...device.properties,
locked: !variables.properties.locked,
},
}
}
)
},
onError: async (_error, variables) => {
params.onError?.()

await queryClient.invalidateQueries({
queryKey: ['devices', 'list'],
})
await queryClient.invalidateQueries({
queryKey: ['devices', 'get', { device_id: variables.device_id }],
})
},
onSuccess() {
params.onSuccess?.()
},
})
}
Loading
Loading