Adding AS types & grant requests support to open-payments client

packages/open-payments/scripts/generate-types.ts

@@ -1,16 +1,32 @@
 import fs from 'fs'
 import openapiTS from 'openapi-typescript'
 import config from '../src/config'
+
+const generateTypesFromOpenApi = async (
+  specUrl: string,
+  outputFileName: string
+) => {
+  const generatedTypesOutput = await openapiTS(specUrl)
+
+  fs.writeFile(outputFileName, generatedTypesOutput, (error) => {
+    if (error) {
+      console.log(`Error when writing types to ${outputFileName}`, { error })
+    }
+  })
+}
+
 ;(async () => {
-  try {
-    const output = await openapiTS(config.OPEN_PAYMENTS_OPEN_API_URL)
-    const fileName = 'src/generated/types.ts'
+  const rootFolder = `src/generated`
 
-    fs.writeFile(fileName, output, (error) => {
-      if (error) {
-        console.log(`Error when writing types to ${fileName}`, { error })
-      }
-    })
+  try {
+    await generateTypesFromOpenApi(
+      config.OPEN_PAYMENTS_RS_OPEN_API_URL,
+      `${rootFolder}/resource-server-types.ts`
+    )
+    await generateTypesFromOpenApi(
+      config.OPEN_PAYMENTS_AS_OPEN_API_URL,
+      `${rootFolder}/auth-server-types.ts`
+    )
   } catch (error) {
     console.log('Error when generating types', {
       error

packages/open-payments/src/client/grant.test.ts

@@ -0,0 +1,31 @@
+import { createGrantRoutes } from './grant'
+import { OpenAPI, HttpMethod, createOpenAPI } from 'openapi'
+import config from '../config'
+import { defaultAxiosInstance, silentLogger } from '../test/helpers'
+
+describe('grant', (): void => {
+  let openApi: OpenAPI
+
+  beforeAll(async () => {
+    openApi = await createOpenAPI(config.OPEN_PAYMENTS_AS_OPEN_API_URL)
+  })
+
+  const axiosInstance = defaultAxiosInstance
+  const logger = silentLogger
+
+  describe('createGrantRoutes', (): void => {
+    test('creates response validators for grant requests', async (): Promise<void> => {
+      jest.spyOn(openApi, 'createResponseValidator')
+
+      createGrantRoutes({ axiosInstance, openApi, logger })
+      expect(openApi.createResponseValidator).toHaveBeenNthCalledWith(1, {
+        path: '/',
+        method: HttpMethod.POST
+      })
+      expect(openApi.createResponseValidator).toHaveBeenNthCalledWith(2, {
+        path: '/',
+        method: HttpMethod.POST
+      })
+    })
+  })
+})

packages/open-payments/src/client/grant.ts

@@ -0,0 +1,58 @@
+import { HttpMethod } from 'openapi'
+import { ClientDeps } from '.'
+import {
+  getASPath,
+  InteractiveGrant,
+  InteractiveGrantRequest,
+  NonInteractiveGrant,
+  NonInteractiveGrantRequest
+} from '../types'
+import { post } from './requests'
+
+interface RequestGrantArgs<T> {
+  url: string
+  request: T
+}
+
+export interface GrantRoutes {
+  requestInteractiveGrant(
+    args: RequestGrantArgs<InteractiveGrantRequest>
+  ): Promise<InteractiveGrant>
+  requestNonInteractiveGrant(
+    args: RequestGrantArgs<NonInteractiveGrantRequest>
+  ): Promise<NonInteractiveGrant>
+}
+
+export const createGrantRoutes = (clientDeps: ClientDeps): GrantRoutes => {
+  const { axiosInstance, openApi, logger } = clientDeps
+
+  const createInteractiveGrantValidator =
+    openApi.createResponseValidator<InteractiveGrant>({
+      path: getASPath('/'),
+      method: HttpMethod.POST
+    })
+  const createNonInteractiveGrantValidator =
+    openApi.createResponseValidator<NonInteractiveGrant>({
+      path: getASPath('/'),
+      method: HttpMethod.POST
+    })
+
+  return {
+    requestInteractiveGrant: (
+      args: RequestGrantArgs<InteractiveGrantRequest>
+    ) =>
+      post(
+        { axiosInstance, logger },
+        { url: args.url, body: args.request },
+        createInteractiveGrantValidator
+      ),
+    requestNonInteractiveGrant: (
+      args: RequestGrantArgs<NonInteractiveGrantRequest>
+    ) =>
+      post(
+        { axiosInstance, logger },
+        { url: args.url, body: args.request },
+        createNonInteractiveGrantValidator
+      )
+  }
+}

packages/open-payments/src/client/ilp-stream-connection.test.ts

@@ -7,7 +7,7 @@ describe('ilp-stream-connection', (): void => {
   let openApi: OpenAPI
 
   beforeAll(async () => {
-    openApi = await createOpenAPI(config.OPEN_PAYMENTS_OPEN_API_URL)
+    openApi = await createOpenAPI(config.OPEN_PAYMENTS_RS_OPEN_API_URL)
   })
 
   const axiosInstance = defaultAxiosInstance

packages/open-payments/src/client/ilp-stream-connection.ts

@@ -1,6 +1,6 @@
 import { HttpMethod } from 'openapi'
 import { ClientDeps } from '.'
-import { getPath, ILPStreamConnection } from '../types'
+import { getRSPath, ILPStreamConnection } from '../types'
 import { get } from './requests'
 
 interface GetArgs {
@@ -18,7 +18,7 @@ export const createILPStreamConnectionRoutes = (
 
   const getILPStreamConnectionValidator =
     openApi.createResponseValidator<ILPStreamConnection>({
-      path: getPath('/connections/{id}'),
+      path: getRSPath('/connections/{id}'),
       method: HttpMethod.GET
     })
 

packages/open-payments/src/client/incoming-payment.test.ts

@@ -18,7 +18,7 @@ describe('incoming-payment', (): void => {
   let openApi: OpenAPI
 
   beforeAll(async () => {
-    openApi = await createOpenAPI(config.OPEN_PAYMENTS_OPEN_API_URL)
+    openApi = await createOpenAPI(config.OPEN_PAYMENTS_RS_OPEN_API_URL)
   })
 
   const axiosInstance = defaultAxiosInstance

packages/open-payments/src/client/incoming-payment.ts

@@ -1,6 +1,6 @@
 import { HttpMethod, ResponseValidator } from 'openapi'
 import { ClientDeps } from '.'
-import { IncomingPayment, getPath } from '../types'
+import { IncomingPayment, getRSPath } from '../types'
 import { get } from './requests'
 
 interface GetArgs {
@@ -19,7 +19,7 @@ export const createIncomingPaymentRoutes = (
 
   const getIncomingPaymentOpenApiValidator =
     openApi.createResponseValidator<IncomingPayment>({
-      path: getPath('/incoming-payments/{id}'),
+      path: getRSPath('/incoming-payments/{id}'),
       method: HttpMethod.GET
     })
 

packages/open-payments/src/client/index.ts

@@ -15,6 +15,7 @@ import {
 } from './payment-pointer'
 import { createAxiosInstance } from './requests'
 import { AxiosInstance } from 'axios'
+import { createGrantRoutes, GrantRoutes } from './grant'
 
 export interface CreateOpenPaymentClientArgs {
   requestTimeoutMs?: number
@@ -31,6 +32,7 @@ export interface OpenPaymentsClient {
   incomingPayment: IncomingPaymentRoutes
   ilpStreamConnection: ILPStreamConnectionRoutes
   paymentPointer: PaymentPointerRoutes
+  grant: GrantRoutes
 }
 
 export const createClient = async (
@@ -40,13 +42,34 @@ export const createClient = async (
     requestTimeoutMs:
       args?.requestTimeoutMs ?? config.DEFAULT_REQUEST_TIMEOUT_MS
   })
-  const openApi = await createOpenAPI(config.OPEN_PAYMENTS_OPEN_API_URL)
+  const resourceServerOpenApi = await createOpenAPI(
+    config.OPEN_PAYMENTS_RS_OPEN_API_URL
+  )
+  const authorizationServerOpenApi = await createOpenAPI(
+    config.OPEN_PAYMENTS_AS_OPEN_API_URL
+  )
   const logger = args?.logger ?? createLogger()
-  const deps = { axiosInstance, openApi, logger }
 
   return {
-    incomingPayment: createIncomingPaymentRoutes(deps),
-    ilpStreamConnection: createILPStreamConnectionRoutes(deps),
-    paymentPointer: createPaymentPointerRoutes(deps)
+    incomingPayment: createIncomingPaymentRoutes({
+      axiosInstance,
+      openApi: resourceServerOpenApi,
+      logger
+    }),
+    ilpStreamConnection: createILPStreamConnectionRoutes({
+      axiosInstance,
+      openApi: resourceServerOpenApi,
+      logger
+    }),
+    paymentPointer: createPaymentPointerRoutes({
+      axiosInstance,
+      openApi: resourceServerOpenApi,
+      logger
+    }),
+    grant: createGrantRoutes({
+      axiosInstance,
+      openApi: authorizationServerOpenApi,
+      logger
+    })
   }
 }

packages/open-payments/src/client/payment-pointer.test.ts

@@ -7,7 +7,7 @@ describe('payment-pointer', (): void => {
   let openApi: OpenAPI
 
   beforeAll(async () => {
-    openApi = await createOpenAPI(config.OPEN_PAYMENTS_OPEN_API_URL)
+    openApi = await createOpenAPI(config.OPEN_PAYMENTS_RS_OPEN_API_URL)
   })
 
   const axiosInstance = defaultAxiosInstance

packages/open-payments/src/client/payment-pointer.ts

@@ -1,6 +1,6 @@
 import { HttpMethod } from 'openapi'
 import { ClientDeps } from '.'
-import { PaymentPointer, getPath } from '../types'
+import { PaymentPointer, getRSPath } from '../types'
 import { get } from './requests'
 
 interface GetArgs {
@@ -18,7 +18,7 @@ export const createPaymentPointerRoutes = (
 
   const getPaymentPaymentValidator =
     openApi.createResponseValidator<PaymentPointer>({
-      path: getPath('/'),
+      path: getRSPath('/'),
       method: HttpMethod.GET
     })
 

packages/open-payments/src/client/requests.test.ts

@@ -1,5 +1,5 @@
 /* eslint-disable @typescript-eslint/no-empty-function */
-import { createAxiosInstance, get } from './requests'
+import { createAxiosInstance, get, post } from './requests'
 import nock from 'nock'
 import { mockOpenApiResponseValidators, silentLogger } from '../test/helpers'
 
@@ -114,4 +114,81 @@ describe('requests', (): void => {
       ).rejects.toThrow(/Failed to validate OpenApi response/)
     })
   })
+
+  describe('post', (): void => {
+    const axiosInstance = createAxiosInstance({ requestTimeoutMs: 0 })
+    const baseUrl = 'http://localhost:1000'
+    const responseValidators = mockOpenApiResponseValidators()
+
+    beforeAll(() => {
+      jest.spyOn(axiosInstance, 'post')
+    })
+
+    test('properly POSTs request', async (): Promise<void> => {
+      const status = 200
+      const body = {
+        id: 'id'
+      }
+
+      nock(baseUrl).post('/grant', body).reply(status, body)
+
+      await post(
+        { axiosInstance, logger },
+        {
+          url: `${baseUrl}/grant`,
+          body
+        },
+        responseValidators.successfulValidator
+      )
+
+      expect(axiosInstance.post).toHaveBeenCalledWith(`${baseUrl}/grant`, body)
+    })
+
+    test('calls validator function properly', async (): Promise<void> => {
+      const status = 200
+      const body = {
+        id: 'id'
+      }
+
+      nock(baseUrl).post('/grant', body).reply(status, body)
+
+      const responseValidatorSpy = jest.spyOn(
+        responseValidators,
+        'successfulValidator'
+      )
+
+      await post(
+        { axiosInstance, logger },
+        {
+          url: `${baseUrl}/grant`,
+          body
+        },
+        responseValidators.successfulValidator
+      )
+
+      expect(responseValidatorSpy).toHaveBeenCalledWith({
+        body,
+        status
+      })
+    })
+
+    test('throws if response validator function fails', async (): Promise<void> => {
+      const status = 200
+      const body = {
+        id: 'id'
+      }
+      nock(baseUrl).post('/grant', body).reply(status, body)
+
+      await expect(
+        post(
+          { axiosInstance, logger },
+          {
+            url: `${baseUrl}/grant`,
+            body
+          },
+          responseValidators.failedValidator
+        )
+      ).rejects.toThrow(/Failed to validate OpenApi response/)
+    })
+  })
 })