Skip to content
Merged
Show file tree
Hide file tree
Changes from all 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
11 changes: 6 additions & 5 deletions src/lib/request-parameters.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ export type RequireAtLeastOne<
T,
Keys extends keyof T = keyof T,
> = Keys extends keyof T
? Required<Pick<T, Keys>> & Partial<Omit<T, Keys>>
? { [Key in Keys]-?: Exclude<T[Key], undefined> } & Partial<Omit<T, Keys>>
: never

export const assertValidRequestParameters = (
Expand All @@ -25,9 +25,10 @@ export const assertValidRequestParameters = (
throw new TypeError(`Parameters for ${path} must be an object`)
}

if (hasRequiredParameters && Object.keys(parameters).length === 0) {
throw new TypeError(
`Parameters for ${path} must contain at least one property`,
)
if (
hasRequiredParameters &&
Object.values(parameters).every((value) => value === undefined)
) {
throw new TypeError(`At least one parameter is required for ${path}`)
}
}
27 changes: 26 additions & 1 deletion test/seam/connect/request-parameters.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,17 @@ test('endpoint rejects missing required parameters', (t) => {
message: 'Parameters are required for /devices/get',
},
)

t.throws(
() => {
// @ts-expect-error Verify an explicitly required schema property makes the argument required.
seam.devices.reportProviderMetadata()
},
{
instanceOf: TypeError,
message: 'Parameters are required for /devices/report_provider_metadata',
},
)
})

test('endpoint rejects an empty required parameters object', (t) => {
Expand All @@ -25,7 +36,20 @@ test('endpoint rejects an empty required parameters object', (t) => {
},
{
instanceOf: TypeError,
message: 'Parameters for /devices/get must contain at least one property',
message: 'At least one parameter is required for /devices/get',
},
)
})

test('endpoint rejects required parameters with only undefined values', (t) => {
t.throws(
() => {
// @ts-expect-error Verify RequireAtLeastOne requires a defined value.
seam.devices.get({ device_id: undefined })
},
{
instanceOf: TypeError,
message: 'At least one parameter is required for /devices/get',
},
)
})
Expand All @@ -50,4 +74,5 @@ test('endpoint accepts omitted optional parameters', (t) => {
test('endpoint accepts required parameters', (t) => {
t.notThrows(() => seam.devices.get({ device_id: 'device-id' }))
t.notThrows(() => seam.devices.get({ name: 'Front Door' }))
t.notThrows(() => seam.devices.reportProviderMetadata({ devices: [] }))
})
Loading