fix: Validate required method params

Author: razor-x

codegen/layouts/partials/route-class-endpoint-export.hbs

@@ -1,4 +1,4 @@
-export type {{parametersTypeName}} = {{> request-object parameters=parameters}}
+export type {{parametersTypeName}} = {{#if requiresAtLeastOneParameter}}RequireAtLeastOne<{{/if}}{{> request-object parameters=parameters}}{{#if requiresAtLeastOneParameter}}>{{/if}}
 
 /**
  * @deprecated Use {{requestTypeName}} instead.

codegen/layouts/partials/route-class-endpoint.hbs

@@ -2,6 +2,8 @@
 {{methodName}}
 {{> endpont-method-signature }}
 {
+  assertValidRequestParameters(parameters, '{{path}}', {{hasRequiredParameters}})
+
   return new SeamHttpRequest(this, {
     pathname: '{{path}}',
     method: '{{method}}',

codegen/layouts/route.hbs

@@ -5,6 +5,13 @@
 
 {{> route-imports }}
 
+{{#if endpoints}}
+import { assertValidRequestParameters } from 'lib/request-parameters.js'
+{{/if}}
+{{#if needsRequireAtLeastOneImport}}
+import type { RequireAtLeastOne } from 'lib/request-parameters.js'
+{{/if}}
+
 export class {{className}} {
   {{> route-class-methods }}
 

codegen/lib/layouts/route.ts

@@ -10,6 +10,7 @@ export interface RouteLayoutContext {
   subroutes: SubrouteLayoutContext[]
   skipClientSessionImport: boolean
   needsActionAttemptsImport: boolean
+  needsRequireAtLeastOneImport: boolean
   resourceTypeImports: ResourceTypeImport[]
 }
 
@@ -35,6 +36,8 @@ export interface EndpointLayoutContext {
   returnsActionAttempt: boolean
   returnsVoid: boolean
   isOptionalParamsOk: boolean
+  hasRequiredParameters: boolean
+  requiresAtLeastOneParameter: boolean
   parameters: Parameter[]
   responseIsList: boolean
   responseResourceTypeName: string
@@ -64,6 +67,10 @@ export const setRouteLayoutContext = (
     node.path !== '/action_attempts' &&
     'endpoints' in node &&
     node.endpoints.some(isActionAttemptEndpoint)
+  file.needsRequireAtLeastOneImport =
+    node != null &&
+    'endpoints' in node &&
+    node.endpoints.some(requiresAtLeastOneParameter)
   file.resourceTypeImports =
     node != null && 'endpoints' in node
       ? [
@@ -140,9 +147,9 @@ export const getEndpointLayoutContext = (
     responseTypeName: `${prefix}Response`,
     optionsTypeName: `${prefix}Options`,
     requestTypeName: `${prefix}Request`,
-    isOptionalParamsOk: endpoint.request.parameters.every(
-      (parameter) => !parameter.isRequired,
-    ),
+    isOptionalParamsOk: !endpoint.request.hasRequiredParameters,
+    hasRequiredParameters: endpoint.request.hasRequiredParameters,
+    requiresAtLeastOneParameter: requiresAtLeastOneParameter(endpoint),
     parameters: endpoint.request.parameters,
     responseIsList: endpoint.response.responseType === 'resource_list',
     responseResourceTypeName:
@@ -155,6 +162,10 @@ export const getEndpointLayoutContext = (
   }
 }
 
+const requiresAtLeastOneParameter = (endpoint: Endpoint): boolean =>
+  endpoint.request.hasRequiredParameters &&
+  endpoint.request.parameters.every(({ isRequired }) => !isRequired)
+
 const isActionAttemptEndpoint = (endpoint: Endpoint): boolean =>
   endpoint.response.responseType === 'resource' &&
   endpoint.response.resourceType === 'action_attempt'

src/lib/request-parameters.ts

@@ -0,0 +1,33 @@
+export type RequireAtLeastOne<
+  T,
+  Keys extends keyof T = keyof T,
+> = Keys extends keyof T
+  ? Required<Pick<T, Keys>> & Partial<Omit<T, Keys>>
+  : never
+
+export const assertValidRequestParameters = (
+  parameters: unknown,
+  path: string,
+  hasRequiredParameters: boolean,
+): void => {
+  if (parameters === undefined) {
+    if (hasRequiredParameters) {
+      throw new TypeError(`Parameters are required for ${path}`)
+    }
+    return
+  }
+
+  if (
+    parameters === null ||
+    typeof parameters !== 'object' ||
+    Array.isArray(parameters)
+  ) {
+    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`,
+    )
+  }
+}

test/seam/connect/request-parameters.test.ts

@@ -0,0 +1,53 @@
+import test from 'ava'
+
+import { SeamHttp } from '@seamapi/http/connect'
+
+const seam = SeamHttp.fromApiKey('seam_apikey1_token')
+
+test('endpoint rejects missing required parameters', (t) => {
+  t.throws(
+    () => {
+      // @ts-expect-error Verify requiredness in the generated method signature.
+      seam.devices.get()
+    },
+    {
+      instanceOf: TypeError,
+      message: 'Parameters are required for /devices/get',
+    },
+  )
+})
+
+test('endpoint rejects an empty required parameters object', (t) => {
+  t.throws(
+    () => {
+      // @ts-expect-error Verify RequireAtLeastOne in the generated parameter type.
+      seam.devices.get({})
+    },
+    {
+      instanceOf: TypeError,
+      message: 'Parameters for /devices/get must contain at least one property',
+    },
+  )
+})
+
+test('endpoint rejects non-object parameters', (t) => {
+  t.throws(
+    () => {
+      // @ts-expect-error Verify the generated parameter type rejects primitives.
+      seam.devices.list('invalid')
+    },
+    {
+      instanceOf: TypeError,
+      message: 'Parameters for /devices/list must be an object',
+    },
+  )
+})
+
+test('endpoint accepts omitted optional parameters', (t) => {
+  t.notThrows(() => seam.devices.list())
+})
+
+test('endpoint accepts required parameters', (t) => {
+  t.notThrows(() => seam.devices.get({ device_id: 'device-id' }))
+  t.notThrows(() => seam.devices.get({ name: 'Front Door' }))
+})

test/seam/connect/seam-paginator.test.ts

@@ -14,10 +14,13 @@ test('SeamPaginator: cannot paginate a request with an empty response', async (t
   const { seed, endpoint } = await getTestServer(t)
   const seam = SeamHttp.fromApiKey(seed.seam_apikey1_token, { endpoint })
 
-  // @ts-expect-error Testing validation
-  t.throws(() => seam.createPaginator(seam.devices.update()), {
-    message: /does not support pagination/,
-  })
+  t.throws(
+    () =>
+      seam.createPaginator(
+        seam.devices.update({ device_id: 'test-device-id' }),
+      ),
+    { message: /does not support pagination/ },
+  )
 })
 
 // TODO: Validate the request supports pagination by extending SeamHttpRequest with this knowledge via codegen.