@seamapi/http 2.5.0 → 2.6.0

package/src/lib/routes/webhooks/webhooks.ts

@@ -28,7 +28,6 @@ import {
   limitToSeamHttpRequestOptions,
   parseOptions,
 } from 'lib/parse-options.js'
-import { assertValidRequestParameters } from 'lib/request-parameters.js'
 import type { Webhook } from 'lib/resources/webhook.js'
 import { SeamHttpClientSessions } from 'lib/routes/client-sessions/index.js'
 import { SeamHttpRequest } from 'lib/seam-http-request.js'
@@ -166,12 +165,13 @@ export class SeamHttpWebhooks {
     parameters: WebhooksCreateParameters,
     options: WebhooksCreateOptions = {},
   ): WebhooksCreateRequest {
-    assertValidRequestParameters(parameters, '/webhooks/create', true, ['url'])
-
     return new SeamHttpRequest(this, {
       pathname: '/webhooks/create',
       method: 'POST',
       body: parameters,
+      parameters,
+      hasRequiredParameters: true,
+      requiredParameterNames: ['url'],
       responseKey: 'webhook',
       options,
     })
@@ -184,14 +184,13 @@ export class SeamHttpWebhooks {
     parameters: WebhooksDeleteParameters,
     options: WebhooksDeleteOptions = {},
   ): WebhooksDeleteRequest {
-    assertValidRequestParameters(parameters, '/webhooks/delete', true, [
-      'webhook_id',
-    ])
-
     return new SeamHttpRequest(this, {
       pathname: '/webhooks/delete',
       method: 'DELETE',
       params: parameters,
+      parameters,
+      hasRequiredParameters: true,
+      requiredParameterNames: ['webhook_id'],
       responseKey: undefined,
       options,
     })
@@ -204,14 +203,13 @@ export class SeamHttpWebhooks {
     parameters: WebhooksGetParameters,
     options: WebhooksGetOptions = {},
   ): WebhooksGetRequest {
-    assertValidRequestParameters(parameters, '/webhooks/get', true, [
-      'webhook_id',
-    ])
-
     return new SeamHttpRequest(this, {
       pathname: '/webhooks/get',
       method: 'GET',
       params: parameters,
+      parameters,
+      hasRequiredParameters: true,
+      requiredParameterNames: ['webhook_id'],
       responseKey: 'webhook',
       options,
     })
@@ -224,12 +222,13 @@ export class SeamHttpWebhooks {
     parameters?: WebhooksListParameters,
     options: WebhooksListOptions = {},
   ): WebhooksListRequest {
-    assertValidRequestParameters(parameters, '/webhooks/list', false, [])
-
     return new SeamHttpRequest(this, {
       pathname: '/webhooks/list',
       method: 'GET',
       params: parameters,
+      parameters,
+      hasRequiredParameters: false,
+      requiredParameterNames: [],
       responseKey: 'webhooks',
       options,
     })
@@ -242,15 +241,13 @@ export class SeamHttpWebhooks {
     parameters: WebhooksUpdateParameters,
     options: WebhooksUpdateOptions = {},
   ): WebhooksUpdateRequest {
-    assertValidRequestParameters(parameters, '/webhooks/update', true, [
-      'event_types',
-      'webhook_id',
-    ])
-
     return new SeamHttpRequest(this, {
       pathname: '/webhooks/update',
       method: 'PUT',
       body: parameters,
+      parameters,
+      hasRequiredParameters: true,
+      requiredParameterNames: ['event_types', 'webhook_id'],
       responseKey: undefined,
       options,
     })

package/src/lib/routes/workspaces/workspaces.ts

@@ -28,7 +28,6 @@ import {
   limitToSeamHttpRequestOptions,
   parseOptions,
 } from 'lib/parse-options.js'
-import { assertValidRequestParameters } from 'lib/request-parameters.js'
 import type { ActionAttempt } from 'lib/resources/action-attempt.js'
 import type { Workspace } from 'lib/resources/workspace.js'
 import { SeamHttpActionAttempts } from 'lib/routes/action-attempts/index.js'
@@ -168,14 +167,13 @@ export class SeamHttpWorkspaces {
     parameters: WorkspacesCreateParameters,
     options: WorkspacesCreateOptions = {},
   ): WorkspacesCreateRequest {
-    assertValidRequestParameters(parameters, '/workspaces/create', true, [
-      'name',
-    ])
-
     return new SeamHttpRequest(this, {
       pathname: '/workspaces/create',
       method: 'POST',
       body: parameters,
+      parameters,
+      hasRequiredParameters: true,
+      requiredParameterNames: ['name'],
       responseKey: 'workspace',
       options,
     })
@@ -188,12 +186,13 @@ export class SeamHttpWorkspaces {
     parameters?: WorkspacesGetParameters,
     options: WorkspacesGetOptions = {},
   ): WorkspacesGetRequest {
-    assertValidRequestParameters(parameters, '/workspaces/get', false, [])
-
     return new SeamHttpRequest(this, {
       pathname: '/workspaces/get',
       method: 'GET',
       params: parameters,
+      parameters,
+      hasRequiredParameters: false,
+      requiredParameterNames: [],
       responseKey: 'workspace',
       options,
     })
@@ -206,12 +205,13 @@ export class SeamHttpWorkspaces {
     parameters?: WorkspacesListParameters,
     options: WorkspacesListOptions = {},
   ): WorkspacesListRequest {
-    assertValidRequestParameters(parameters, '/workspaces/list', false, [])
-
     return new SeamHttpRequest(this, {
       pathname: '/workspaces/list',
       method: 'GET',
       params: parameters,
+      parameters,
+      hasRequiredParameters: false,
+      requiredParameterNames: [],
       responseKey: 'workspaces',
       options,
     })
@@ -224,17 +224,13 @@ export class SeamHttpWorkspaces {
     parameters?: WorkspacesResetSandboxParameters,
     options: WorkspacesResetSandboxOptions = {},
   ): WorkspacesResetSandboxRequest {
-    assertValidRequestParameters(
-      parameters,
-      '/workspaces/reset_sandbox',
-      false,
-      [],
-    )
-
     return new SeamHttpRequest(this, {
       pathname: '/workspaces/reset_sandbox',
       method: 'POST',
       body: parameters,
+      parameters,
+      hasRequiredParameters: false,
+      requiredParameterNames: [],
       responseKey: 'action_attempt',
       options,
       actionAttempts: SeamHttpActionAttempts.fromClient(this.client, {
@@ -251,12 +247,13 @@ export class SeamHttpWorkspaces {
     parameters?: WorkspacesUpdateParameters,
     options: WorkspacesUpdateOptions = {},
   ): WorkspacesUpdateRequest {
-    assertValidRequestParameters(parameters, '/workspaces/update', false, [])
-
     return new SeamHttpRequest(this, {
       pathname: '/workspaces/update',
       method: 'PATCH',
       body: parameters,
+      parameters,
+      hasRequiredParameters: false,
+      requiredParameterNames: [],
       responseKey: undefined,
       options,
     })

package/src/lib/seam-http-request.ts

@@ -1,13 +1,14 @@
-import { serializeUrlSearchParams } from '@seamapi/url-search-params-serializer'
 import type { Method } from 'axios'
 
 import type { Client } from './client.js'
 import type { SeamHttpRequestOptions } from './options.js'
+import { assertValidRequestParameters } from './request-parameters.js'
 import {
   type ActionAttemptsClient,
   resolveActionAttempt,
 } from './resolve-action-attempt.js'
 import type { ActionAttempt } from './resources/action-attempt.js'
+import { serializeUrlSearchParams } from './url-search-params-serializer.js'
 
 interface SeamHttpRequestParent {
   readonly client: Client
@@ -22,6 +23,9 @@ interface SeamHttpRequestConfig<TResponseKey> {
   readonly responseKey: TResponseKey
   readonly options?: Pick<SeamHttpRequestOptions, 'waitForActionAttempt'>
   readonly actionAttempts?: ActionAttemptsClient
+  readonly parameters?: unknown
+  readonly hasRequiredParameters?: boolean
+  readonly requiredParameterNames?: readonly string[]
 }
 
 export class SeamHttpRequest<
@@ -122,6 +126,13 @@ export class SeamHttpRequest<
   }
 
   async fetchResponse(): Promise<TResponse> {
+    assertValidRequestParameters(
+      this.#config.parameters,
+      this.pathname,
+      this.#config.hasRequiredParameters ?? false,
+      this.#config.requiredParameterNames ?? [],
+    )
+
     const { client } = this.#parent
     const response = await client.request({
       url: this.pathname,

package/src/lib/url-search-params-serializer.ts

@@ -0,0 +1,28 @@
+import {
+  type Params,
+  serializeUrlSearchParams as baseSerializeUrlSearchParams,
+  UnserializableParamError,
+  updateUrlSearchParams as baseUpdateUrlSearchParams,
+} from '@seamapi/url-search-params-serializer'
+
+export const serializeUrlSearchParams = (params: Params): string => {
+  const queryString = baseSerializeUrlSearchParams(params)
+  if (queryString === '') return ''
+
+  const searchParams = new URLSearchParams(queryString)
+  searchParams.set('_strict', 'true')
+  return searchParams.toString()
+}
+
+export const updateUrlSearchParams = (
+  searchParams: URLSearchParams,
+  params: Params,
+): void => {
+  baseUpdateUrlSearchParams(searchParams, params)
+
+  if (searchParams.size > 0) {
+    searchParams.set('_strict', 'true')
+  }
+}
+
+export { type Params, UnserializableParamError }

package/src/lib/version.ts

@@ -1,3 +1,3 @@
-const seamapiJavascriptHttpVersion = '2.5.0'
+const seamapiJavascriptHttpVersion = '2.6.0'
 
 export default seamapiJavascriptHttpVersion