chore(ts-sdk-client): improve type definitions (#1066)

- improve the process function type definitions

Author: ajimae

.changeset/nice-dryers-relate.md

@@ -0,0 +1,5 @@
+---
+'@commercetools/ts-client': patch
+---
+
+Improve typescript types definitions

packages/sdk-client-v3/src/client/client.ts

@@ -9,6 +9,7 @@ import {
   Client,
   ClientOptions,
   ClientRequest,
+  ClientResponse,
   ClientResult,
   Dispatch,
   Middleware,
@@ -35,11 +36,11 @@ function compose({
 
 // process batch requests
 let _options: ClientOptions
-export function process(
+export function process<T extends object = any>(
   request: ClientRequest,
-  fn: ProcessFn,
+  fn: ProcessFn<T>,
   processOpt?: ProcessOptions
-): Promise<Array<ClientRequest>> {
+): Promise<Array<T>> {
   validate('process', request, { allowedMethods: ['GET'] })
 
   if (typeof fn !== 'function')
@@ -90,8 +91,9 @@ export function process(
       }
 
       try {
-        const payload: ClientResult =
-          await createClient(_options).execute(enhancedRequest)
+        const payload: ClientResult = await createClient(_options).execute(
+          enhancedRequest
+        )
 
         const { results, count: resultsLength } = payload?.body || {}
 

packages/sdk-client-v3/src/types/types.d.ts

@@ -25,9 +25,10 @@ export type HttpErrorType = {
   statusCode: number
   originalRequest?: ClientRequest
   /**
-    * @deprecated
+    * @deprecated use `error` instead
     */
   body?: JsonObject
+  error?: JsonObject
   retryCount?: number
   headers?: Record<string, any>
   [key: string]: any
@@ -83,7 +84,7 @@ export type ClientResponse<T = any> = {
   retryCount?: number
 }
 
-export type ClientResult = ClientResponse
+export type ClientResult<T extends object = any> = ClientResponse<T>
 export type ClientOptions = { middlewares: Array<Middleware> }
 
 export type Credentials = {
@@ -322,15 +323,20 @@ type TResponse = {
 
 export type Client = {
   execute(request: ClientRequest): Promise<ClientResult>
-  process: (
+  process<T extends object = any>(
     request: ClientRequest,
-    fn: ProcessFn,
+    fn: ProcessFn<T>,
     processOpt?: ProcessOptions
-  ) => Promise<unknown>
+  ): Promise<Array<T> | Array<void>>
 }
 
-export type ProcessFn = (result: ClientResult) => Promise<unknown>
-export type ProcessOptions = { accumulate?: boolean; total?: number }
+export type ProcessFn<T extends object> = (result: ClientResult<T>) => Promise<ClientResult<T>>
+export type ProcessOptions = {
+  limit?: number;
+  sort?: string;
+  accumulate?: boolean;
+  total?: number;
+}
 
 export type ErrorHandlerOptions = {
   error: HttpErrorType
@@ -343,9 +349,9 @@ export type ErrorMiddlewareOptions = {
   handler?: (args: ErrorHandlerOptions) => Promise<MiddlewareResponse>
 }
 
-export type SuccessResult = {
+export type SuccessResult<T extends Record<string | number, Record<string, any>>> = {
   body: {
-    results: Record<string | number, Record<string, any>>;
+    results: Array<T>;
     count: number;
   };
   statusCode: number;

packages/sdk-client-v3/tests/client.test/client.test.ts

@@ -4,10 +4,8 @@ import {
   createClient,
   MiddlewareRequest,
   MiddlewareResponse,
-  HttpErrorType,
   Process,
   Client,
-  MethodType,
   ClientBuilder,
 } from '../../src'
 import { createApiBuilderFromCtpClient } from '@commercetools/platform-sdk'
@@ -302,7 +300,7 @@ describe('process', () => {
     })
 
     return client
-      .process(request, () => Promise.resolve('OK'))
+      .process(request, () => Promise.resolve('OK' as any))
       .then((response) => {
         expect(response).toEqual(['OK', 'OK', 'OK'])
       })
@@ -360,7 +358,7 @@ describe('process', () => {
     })
 
     return client
-      .process(request, () => Promise.resolve('OK'), { total: 46 })
+      .process(request, () => Promise.resolve('OK' as any), { total: 46 })
       .then((response) => {
         expect(response).toEqual(['OK', 'OK', 'OK'])
       })
@@ -418,7 +416,7 @@ describe('process', () => {
           limit: 5,
         })}`,
       },
-      () => Promise.resolve('OK')
+      () => Promise.resolve('OK') as any
     )
   })
 
@@ -529,7 +527,7 @@ describe('process - exposed', () => {
       ],
     })
 
-    return Process(request, () => Promise.resolve('OK'), {}).then(
+    return Process(request, () => Promise.resolve('OK') as any, {}).then(
       (response) => {
         expect(response).toEqual(['OK', 'OK', 'OK'])
       }
@@ -582,11 +580,11 @@ describe('process - exposed', () => {
       ],
     })
 
-    return Process(request, () => Promise.resolve('OK'), { total: 46 }).then(
-      (response) => {
-        expect(response).toEqual(['OK', 'OK', 'OK'])
-      }
-    )
+    return Process(request, () => Promise.resolve('OK') as any, {
+      total: 46,
+    }).then((response) => {
+      expect(response).toEqual(['OK', 'OK', 'OK'])
+    })
   })
 
   test('process and resolve pagination by preserving original query', () => {
@@ -635,7 +633,7 @@ describe('process - exposed', () => {
           limit: 5,
         })}`,
       },
-      () => Promise.resolve('OK'),
+      () => Promise.resolve('OK') as any,
       {}
     )
   })
@@ -688,7 +686,7 @@ describe('process - exposed', () => {
     })
 
     let fnCall = 0
-    const processRes = await Process(
+    const processRes = await Process<{ results: [] }>(
       {
         ...request,
         uri: `${request.uri}?${stringifyURLString({
@@ -698,11 +696,11 @@ describe('process - exposed', () => {
         })}`,
       },
       (res) => {
-        expect(res.body.results).toEqual(reqStubs[fnCall].body.results)
+        expect(res.body?.results).toEqual(reqStubs[fnCall].body.results)
         expect(fnCall).toBeLessThan(2) // should not call fn if the last page is empty
 
         fnCall += 1
-        return Promise.resolve(`OK${fnCall}`)
+        return Promise.resolve(`OK${fnCall}`) as any
       },
       {
         accumulate: true,
@@ -713,7 +711,7 @@ describe('process - exposed', () => {
     expect(fnCall).toBe(2) // fn was called two times
   })
 
-  test('process and reject on rejection from user', () => {
+  test('process and reject on rejection from user', async () => {
     createClient({
       middlewares: [
         (next) =>

tsconfig.json

@@ -10,13 +10,5 @@
     "resolveJsonModule": true,
     "downlevelIteration": true
   },
-  "exclude": ["./examples/"]
-  // "references": [
-  //   {
-  //     "path": "./packages/sdk-client"
-  //   },
-  //   {
-  //     "path": "./packages/sdk-client-v3"
-  //   }
-  // ]
+  "include": ["packages"]
 }