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,28 @@
+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 validator for grant requests', async (): Promise<void> => {
+      jest.spyOn(openApi, 'createResponseValidator')
+
+      createGrantRoutes({ axiosInstance, openApi, logger })
+      expect(openApi.createResponseValidator).toHaveBeenCalledTimes(1)
+      expect(openApi.createResponseValidator).toHaveBeenCalledWith({
+        path: '/',
+        method: HttpMethod.POST
+      })
+    })
+  })
+})

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

@@ -0,0 +1,41 @@
+import { HttpMethod } from 'openapi'
+import { RouteDeps } from '.'
+import {
+  getASPath,
+  InteractiveGrant,
+  NonInteractiveGrant,
+  GrantRequest
+} from '../types'
+import { post } from './requests'
+
+interface RequestGrantArgs {
+  url: string
+  request: GrantRequest
+}
+
+export interface GrantRoutes {
+  requestGrant(
+    args: RequestGrantArgs
+  ): Promise<InteractiveGrant | NonInteractiveGrant>
+}
+
+export const createGrantRoutes = (deps: RouteDeps): GrantRoutes => {
+  const requestGrantValidator = deps.openApi.createResponseValidator<
+    InteractiveGrant | NonInteractiveGrant
+  >({
+    path: getASPath('/'),
+    method: HttpMethod.POST
+  })
+  return {
+    requestGrant: (args: RequestGrantArgs) =>
+      post(deps, { url: args.url, body: args.request }, requestGrantValidator)
+  }
+}
+
+export const isInteractiveGrant = (
+  grant: InteractiveGrant | NonInteractiveGrant
+): grant is InteractiveGrant => !!(grant as InteractiveGrant).interact
+
+export const isNonInteractiveGrant = (
+  grant: InteractiveGrant | NonInteractiveGrant
+): grant is NonInteractiveGrant => !!(grant as NonInteractiveGrant).access_token

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 { RouteDeps } from '.'
+import { getRSPath, ILPStreamConnection } from '../types'
 import { get } from './requests'
 
 interface GetArgs {
@@ -12,13 +12,13 @@ export interface ILPStreamConnectionRoutes {
 }
 
 export const createILPStreamConnectionRoutes = (
-  clientDeps: ClientDeps
+  deps: RouteDeps
 ): ILPStreamConnectionRoutes => {
-  const { axiosInstance, openApi, logger } = clientDeps
+  const { axiosInstance, openApi, logger } = deps
 
   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 { BaseDeps, RouteDeps } from '.'
+import { IncomingPayment, getRSPath } from '../types'
 import { get } from './requests'
 
 interface GetArgs {
@@ -13,13 +13,13 @@ export interface IncomingPaymentRoutes {
 }
 
 export const createIncomingPaymentRoutes = (
-  clientDeps: ClientDeps
+  deps: RouteDeps
 ): IncomingPaymentRoutes => {
-  const { axiosInstance, openApi, logger } = clientDeps
+  const { axiosInstance, openApi, logger } = deps
 
   const getIncomingPaymentOpenApiValidator =
     openApi.createResponseValidator<IncomingPayment>({
-      path: getPath('/incoming-payments/{id}'),
+      path: getRSPath('/incoming-payments/{id}'),
       method: HttpMethod.GET
     })
 
@@ -34,11 +34,11 @@ export const createIncomingPaymentRoutes = (
 }
 
 export const getIncomingPayment = async (
-  clientDeps: Pick<ClientDeps, 'axiosInstance' | 'logger'>,
+  deps: BaseDeps,
   args: GetArgs,
   validateOpenApiResponse: ResponseValidator<IncomingPayment>
 ) => {
-  const { axiosInstance, logger } = clientDeps
+  const { axiosInstance, logger } = deps
   const { url } = args
 
   const incomingPayment = await get(

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

@@ -16,8 +16,19 @@ import {
 } from './payment-pointer'
 import { createAxiosInstance } from './requests'
 import { AxiosInstance } from 'axios'
+import { createGrantRoutes, GrantRoutes } from './grant'
 
-export interface ClientDeps {
+export interface BaseDeps {
+  axiosInstance: AxiosInstance
+  logger: Logger
+}
+
+interface ClientDeps extends BaseDeps {
+  resourceServerOpenApi: OpenAPI
+  authServerOpenApi: OpenAPI
+}
+
+export interface RouteDeps extends BaseDeps {
   axiosInstance: AxiosInstance
   openApi: OpenAPI
   logger: Logger
@@ -32,9 +43,19 @@ const createDeps = 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 authServerOpenApi = await createOpenAPI(
+    config.OPEN_PAYMENTS_AS_OPEN_API_URL
+  )
   const logger = args?.logger ?? createLogger()
-  return { axiosInstance, openApi, logger }
+  return {
+    axiosInstance,
+    resourceServerOpenApi,
+    authServerOpenApi,
+    logger
+  }
 }
 
 export interface CreateUnauthenticatedClientArgs {
@@ -50,11 +71,21 @@ export interface UnauthenticatedClient {
 export const createUnauthenticatedClient = async (
   args: CreateUnauthenticatedClientArgs
 ): Promise<UnauthenticatedClient> => {
-  const deps = await createDeps(args)
+  const { axiosInstance, resourceServerOpenApi, logger } = await createDeps(
+    args
+  )
 
   return {
-    ilpStreamConnection: createILPStreamConnectionRoutes(deps),
-    paymentPointer: createPaymentPointerRoutes(deps)
+    ilpStreamConnection: createILPStreamConnectionRoutes({
+      axiosInstance,
+      openApi: resourceServerOpenApi,
+      logger
+    }),
+    paymentPointer: createPaymentPointerRoutes({
+      axiosInstance,
+      openApi: resourceServerOpenApi,
+      logger
+    })
   }
 }
 
@@ -66,16 +97,35 @@ export interface CreateAuthenticatedClientArgs
 
 export interface AuthenticatedClient extends UnauthenticatedClient {
   incomingPayment: IncomingPaymentRoutes
+  grant: GrantRoutes
 }
 
 export const createAuthenticatedClient = async (
   args: CreateAuthenticatedClientArgs
 ): Promise<AuthenticatedClient> => {
-  const deps = await createDeps(args)
+  const { axiosInstance, resourceServerOpenApi, authServerOpenApi, logger } =
+    await createDeps(args)
 
   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: authServerOpenApi,
+      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 { RouteDeps } from '.'
+import { PaymentPointer, getRSPath } from '../types'
 import { get } from './requests'
 
 interface GetArgs {
@@ -12,13 +12,13 @@ export interface PaymentPointerRoutes {
 }
 
 export const createPaymentPointerRoutes = (
-  clientDeps: ClientDeps
+  deps: RouteDeps
 ): PaymentPointerRoutes => {
-  const { axiosInstance, openApi, logger } = clientDeps
+  const { axiosInstance, openApi, logger } = deps
 
   const getPaymentPaymentValidator =
     openApi.createResponseValidator<PaymentPointer>({
-      path: getPath('/'),
+      path: getRSPath('/'),
       method: HttpMethod.GET
     })