Make url, method, data properties of SeamHttpRequest

Author: phpnode

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

@@ -1,4 +1,4 @@
-import type { AxiosRequestConfig } from 'axios'
+import type { Method } from 'axios'
 
 import type { Client } from './client.js'
 import { SeamHttpActionAttempts } from './index.js'
@@ -10,6 +10,13 @@ export interface SeamHttpRequestParent {
   readonly defaults: Required<SeamHttpRequestOptions>
 }
 
+export interface SeamHttpRequestConfig<TBody> {
+  url?: string
+  method?: Method
+  params?: any
+  data?: TBody
+}
+
 export type ResponseFromSeamHttpRequest<T> =
   T extends SeamHttpRequest<any, infer TResponse, infer TResourceKey>
     ? TResourceKey extends keyof TResponse
@@ -27,27 +34,39 @@ export class SeamHttpRequest<
     >
 {
   readonly parent: SeamHttpRequestParent
-  readonly requestConfig: AxiosRequestConfig<TBody>
+  readonly config: SeamHttpRequestConfig<TBody>
   readonly resourceKey: TResourceKey
   readonly options: Pick<SeamHttpRequestOptions, 'waitForActionAttempt'>
 
   constructor(
     parent: SeamHttpRequestParent,
-    requestConfig: AxiosRequestConfig<TBody>,
+    config: SeamHttpRequestConfig<TBody>,
     resourceKey: TResourceKey,
     options: Pick<SeamHttpRequestOptions, 'waitForActionAttempt'> = {},
   ) {
     this.parent = parent
-    this.requestConfig = requestConfig
+    this.config = config
     this.resourceKey = resourceKey
     this.options = options
   }
 
+  public get url(): string {
+    return this.config.url ?? ''
+  }
+
+  public get method(): Method {
+    return this.config.method ?? 'get'
+  }
+
+  public get data(): TBody {
+    return this.config.data as TBody
+  }
+
   async execute(): Promise<
     TResourceKey extends keyof TResponse ? TResponse[TResourceKey] : undefined
   > {
     const { client } = this.parent
-    const response = await client.request(this.requestConfig)
+    const response = await client.request(this.config)
     if (this.resourceKey === undefined) {
       return undefined as TResourceKey extends keyof TResponse
         ? TResponse[TResourceKey]

test/seam/connect/client.test.ts

@@ -11,8 +11,8 @@ import {
 } from '@seamapi/http/connect'
 
 import {
-  type ResponseFromSeamApiRequest,
-  SeamApiRequest,
+  type ResponseFromSeamHttpRequest,
+  SeamHttpRequest,
 } from 'lib/seam/connect/seam-http-request.js'
 
 test('SeamHttp: fromClient returns instance that uses client', async (t) => {
@@ -165,17 +165,17 @@ test.failing(
   },
 )
 
-test('SeamHttp: request methods return a SeamApiRequest object', async (t) => {
+test('SeamHttp: request methods return a SeamHttpRequest object', async (t) => {
   const { seed, endpoint } = await getTestServer(t)
   const seam = new SeamHttp({
     client: SeamHttp.fromApiKey(seed.seam_apikey1_token, { endpoint }).client,
   })
 
   const deviceRequest = seam.devices.get({ device_id: seed.august_device_1 })
 
-  t.true(deviceRequest instanceof SeamApiRequest)
-  t.is(deviceRequest.requestConfig.url, '/devices/get')
-  t.deepEqual(deviceRequest.requestConfig.data, {
+  t.true(deviceRequest instanceof SeamHttpRequest)
+  t.is(deviceRequest.url, '/devices/get')
+  t.deepEqual(deviceRequest.data, {
     device_id: seed.august_device_1,
   })
   t.is(deviceRequest.resourceKey, 'device')
@@ -184,7 +184,7 @@ test('SeamHttp: request methods return a SeamApiRequest object', async (t) => {
   t.is(device.device_id, seed.august_device_1)
 
   // Ensure that the type of the response is correct.
-  type Expected = ResponseFromSeamApiRequest<typeof deviceRequest>
+  type Expected = ResponseFromSeamHttpRequest<typeof deviceRequest>
 
   const validDeviceType: Expected['device_type'] = 'august_lock'
   t.truthy(validDeviceType)