feat: Using OpenAPI schema in rest & express

__tests__/restAgent.test.ts

@@ -56,7 +56,7 @@ const agent = createAgent<
   plugins: [
     new AgentRestClient({
       url: 'http://localhost:' + port + '/agent',
-      enabledMethods: Object.keys(supportedMethods),
+      enabledMethods: supportedMethods,
     }),
   ],
 })
@@ -116,7 +116,7 @@ const setup = async (): Promise<boolean> => {
 
   const agentRouter = AgentRouter({
     getAgentForRequest: async req => serverAgent,
-    exposedMethods: serverAgent.availableMethods(),
+    exposedMethods: supportedMethods,
   })
 
   return new Promise((resolve, reject) => {

package.json

@@ -40,6 +40,7 @@
     "json-schema": "^0.2.5",
     "lerna": "^3.20.2",
     "lerna-changelog": "^1.0.1",
+    "openapi-types": "^7.0.0",
     "prettier": "^1.19.1",
     "pretty-quick": "^2.0.1",
     "rimraf": "^3.0.2",

packages/daf-express/src/index.ts

@@ -1,6 +1,6 @@
 import { IAgent } from 'daf-core'
 import { Request, Response, NextFunction, Router, json } from 'express'
-import { supportedMethods, IAgentRESTMethod } from 'daf-rest'
+import { supportedMethods } from 'daf-rest'
 import Debug from 'debug'
 
 interface RequestWithAgent extends Request {
@@ -10,7 +10,7 @@ interface RequestWithAgent extends Request {
 export const AgentRouter = (options: {
   getAgentForRequest: (req: Request) => Promise<IAgent>
   exposedMethods: string[]
-  overrides?: Record<string, IAgentRESTMethod>
+  extraMethods?: Array<string>
 }): Router => {
   const router = Router()
   router.use(json())
@@ -19,27 +19,21 @@ export const AgentRouter = (options: {
     next()
   })
 
-  const allMethods: Record<string, IAgentRESTMethod> = { ...supportedMethods, ...options.overrides }
+  const allMethods: Array<string> = supportedMethods.concat(options.extraMethods ? options.extraMethods : [])
 
   for (const exposedMethod of options.exposedMethods) {
-    const method = allMethods[exposedMethod]
-    if (!method) throw Error('Method not supported: ' + exposedMethod)
+    if (!allMethods.includes(exposedMethod)) throw Error('Method not supported: ' + exposedMethod)
     Debug('daf:express:initializing')(exposedMethod)
 
-    switch (method.type) {
-      case 'POST':
-        router.post(method.path, async (req: RequestWithAgent, res: Response, next: NextFunction) => {
-          if (!req.agent) throw Error('Agent not available')
-          try {
-            const result = await req.agent.execute(exposedMethod, req.body)
-            res.status(200).json(result)
-          } catch (e) {
-            res.status(500).json({ error: e.message })
-          }
-        })
-        break
-      // TODO: handle GET
-    }
+    router.post('/' + exposedMethod, async (req: RequestWithAgent, res: Response, next: NextFunction) => {
+      if (!req.agent) throw Error('Agent not available')
+      try {
+        const result = await req.agent.execute(exposedMethod, req.body)
+        res.status(200).json(result)
+      } catch (e) {
+        res.status(500).json({ error: e.message })
+      }
+    })
   }
 
   return router

packages/daf-rest/package.json

@@ -13,6 +13,7 @@
   },
   "devDependencies": {
     "@types/debug": "^4.1.5",
+    "openapi-types": "^7.0.0",
     "typescript": "^3.8.3"
   },
   "files": [

packages/daf-rest/src/__tests__/client.test.ts

@@ -0,0 +1,17 @@
+import { AgentRestClient, supportedMethods } from '../'
+
+describe('daf-rest', () => {
+  it('should support some methods', () => {
+    expect(Array.isArray(supportedMethods)).toEqual(true)
+    expect(supportedMethods.length).toBeGreaterThan(0)
+  })
+
+  it('should be a valid agent plugin', () => {
+    const client = new AgentRestClient({
+      url: 'mock',
+      enabledMethods: supportedMethods,
+    })
+
+    expect(client.methods[supportedMethods[0]]).toBeTruthy()
+  })
+})

packages/daf-rest/src/client.ts

@@ -1,6 +1,5 @@
 import { IAgentPlugin, IPluginMethodMap } from 'daf-core'
-import { supportedMethods } from './methods'
-import { IAgentRESTMethod } from './types'
+import { supportedMethods } from './index'
 
 export class AgentRestClient implements IAgentPlugin {
   readonly methods: IPluginMethodMap = {}
@@ -10,19 +9,20 @@ export class AgentRestClient implements IAgentPlugin {
     url: string
     enabledMethods: string[]
     headers?: Record<string, string>
-    overrides?: Record<string, IAgentRESTMethod>
+    extraMethods?: Array<string>
   }) {
     this.url = options.url
 
-    const allMethods: Record<string, IAgentRESTMethod> = { ...supportedMethods, ...options.overrides }
+    const allMethods: Array<string> = supportedMethods.concat(
+      options.extraMethods ? options.extraMethods : [],
+    )
 
     for (const method of options.enabledMethods) {
-      if (allMethods[method]) {
+      if (allMethods.includes(method)) {
         this.methods[method] = async (args: any) => {
-          // TODO: handle GET
-          const res = await fetch(this.url + allMethods[method].path, {
+          const res = await fetch(this.url + '/' + method, {
             headers: { ...options.headers, 'Content-Type': 'application/json' },
-            method: allMethods[method].type,
+            method: 'post',
             body: JSON.stringify(args),
           })
           const json = await res.json()

packages/daf-rest/src/index.ts

@@ -1,3 +1,4 @@
 export { AgentRestClient } from './client'
-export { supportedMethods } from './methods'
-export * from './types'
+import { openApiSchema } from './openApiSchema'
+export { openApiSchema }
+export const supportedMethods = Object.keys(openApiSchema.paths).map(path => path.slice(1))