@furystack/rest-service 10.1.2 → 11.0.0

package/src/endpoint-generators/create-patch-endpoint.spec.ts

@@ -1,12 +1,12 @@
-import { usingAsync } from '@furystack/utils'
+import { getPort } from '@furystack/core/port-generator'
 import { Injector } from '@furystack/inject'
+import { getDataSetFor } from '@furystack/repository'
 import type { PatchEndpoint } from '@furystack/rest'
+import { usingAsync } from '@furystack/utils'
+import { describe, expect, it } from 'vitest'
+import { useRestService } from '../helpers.js'
 import { createPatchEndpoint } from './create-patch-endpoint.js'
 import { MockClass, setupContext } from './utils.js'
-import { getDataSetFor } from '@furystack/repository'
-import { useRestService } from '../helpers.js'
-import { describe, it, expect } from 'vitest'
-import { getPort } from '@furystack/core/port-generator'
 
 describe('createPatchEndpoint', () => {
   it('Should update the entity and report the success', async () => {
@@ -33,7 +33,7 @@ describe('createPatchEndpoint', () => {
         body: JSON.stringify({ value: 'updated' }),
       })
       expect(response.status).toBe(200)
-      const body = await response.json()
+      const body = (await response.json()) as { value: string }
       expect(body).toEqual({})
       const updated = await getDataSetFor(i, MockClass, 'id').get(i, 'mock')
       expect(updated?.value).toBe('updated')

package/src/endpoint-generators/create-post-endpoint.spec.ts

@@ -1,12 +1,12 @@
-import { usingAsync } from '@furystack/utils'
+import { getPort } from '@furystack/core/port-generator'
 import { Injector } from '@furystack/inject'
+import { getDataSetFor } from '@furystack/repository'
 import type { PostEndpoint } from '@furystack/rest'
+import { usingAsync } from '@furystack/utils'
+import { describe, expect, it } from 'vitest'
+import { useRestService } from '../helpers.js'
 import { createPostEndpoint } from './create-post-endpoint.js'
 import { MockClass, setupContext } from './utils.js'
-import { useRestService } from '../helpers.js'
-import { getDataSetFor } from '@furystack/repository'
-import { describe, it, expect } from 'vitest'
-import { getPort } from '@furystack/core/port-generator'
 
 describe('createPostEndpoint', () => {
   it('Should create the entity and report the success', async () => {
@@ -29,7 +29,7 @@ describe('createPostEndpoint', () => {
         body: JSON.stringify(entityToPost),
       })
       expect(response.status).toBe(201)
-      const body = await response.json()
+      const body = (await response.json()) as { id: string; value: string }
       expect(body).toEqual(entityToPost)
       const posted = await getDataSetFor(i, MockClass, 'id').get(i, entityToPost.id)
       expect(posted?.value).toBe('posted')

package/src/get-schema-from-api.spec.ts

@@ -28,12 +28,13 @@ describe('getSchemaFromApi', () => {
       description: 'Test API Description',
       version: '1.0.0',
       endpoints: {
-        '/example': {
-          isAuthenticated: false,
-          path: '/example',
-          method: 'GET',
-          schema: defaultSchema,
-          schemaName: 'default',
+        GET: {
+          '/example': {
+            isAuthenticated: false,
+            path: '/example',
+            schema: defaultSchema,
+            schemaName: 'default',
+          },
         },
       },
     })
@@ -60,12 +61,13 @@ describe('getSchemaFromApi', () => {
       description: 'Test API Description',
       version: '1.0.0',
       endpoints: {
-        '/validate-query': {
-          isAuthenticated: false,
-          path: '/validate-query',
-          method: 'GET',
-          schema: validationSchema,
-          schemaName: 'ValidateQuery',
+        GET: {
+          '/validate-query': {
+            isAuthenticated: false,
+            path: '/validate-query',
+            schema: validationSchema,
+            schemaName: 'ValidateQuery',
+          },
         },
       },
     })

package/src/get-schema-from-api.ts

@@ -33,9 +33,8 @@ export const defaultSchema: Schema = {
 
 const defaultSchemaName = 'default'
 
-const getDefinitionFromAction = (method: Method, path: string, action: RequestAction<any>): ApiEndpointDefinition => {
+const getDefinitionFromAction = (path: string, action: RequestAction<{ result: unknown }>): ApiEndpointDefinition => {
   return {
-    method,
     path,
     schema: 'schema' in action && typeof action.schema === 'object' ? action.schema : defaultSchema,
     schemaName: 'schemaName' in action && typeof action.schemaName === 'string' ? action.schemaName : defaultSchemaName,
@@ -55,14 +54,20 @@ export const getSchemaFromApi = <T extends RestApiImplementation<RestApi>>({
   description?: string
   version?: string
 }): ApiEndpointSchema => {
-  const endpoints: Record<string, ApiEndpointDefinition> = {}
+  const endpoints: ApiEndpointSchema['endpoints'] = {}
 
   Object.entries(api).forEach(([method, endpointList]) => {
-    Object.entries(endpointList as Record<string, RequestAction<any>>).forEach(([url, requestAction]) => {
-      if (method && url && requestAction) {
-        endpoints[url] = getDefinitionFromAction(method as Method, url, requestAction)
-      }
-    })
+    const methodKey = method as Method
+    if (!endpoints[methodKey]) {
+      endpoints[methodKey] = {}
+    }
+    Object.entries(endpointList as Record<string, RequestAction<{ result: unknown }>>).forEach(
+      ([url, requestAction]) => {
+        if (method && url && requestAction) {
+          endpoints[methodKey]![url] = getDefinitionFromAction(url, requestAction)
+        }
+      },
+    )
   })
 
   return {

package/src/proxy-manager.spec.ts

@@ -253,7 +253,7 @@ describe('ProxyManager', () => {
           req.on('end', () => {
             const body = Buffer.concat(chunks).toString('utf8')
             res.writeHead(200, { 'Content-Type': 'application/json' })
-            res.end(JSON.stringify({ received: JSON.parse(body), method: req.method }))
+            res.end(JSON.stringify({ received: JSON.parse(body) as object, method: req.method }))
           })
         })
 
@@ -841,7 +841,7 @@ describe('ProxyManager', () => {
           // With PathHelper.joinUrl, the URL is now valid and routes to the target server
           // The target server returns 200, demonstrating robust URL handling
           expect(result.status).toBe(200)
-          const body = await result.json()
+          const body = (await result.json()) as { message: string }
           expect(body).toStrictEqual({ message: 'ok' })
 
           // No error event should be emitted since the request succeeded
@@ -1867,7 +1867,7 @@ describe('ProxyManager', () => {
           req.on('end', () => {
             const body = Buffer.concat(chunks).toString('utf8')
             res.writeHead(200, { 'Content-Type': 'application/json' })
-            res.end(JSON.stringify({ method: req.method, body: JSON.parse(body) }))
+            res.end(JSON.stringify({ method: req.method, body: JSON.parse(body) as object }))
           })
         })
 
@@ -1907,7 +1907,7 @@ describe('ProxyManager', () => {
           req.on('end', () => {
             const body = Buffer.concat(chunks).toString('utf8')
             res.writeHead(200, { 'Content-Type': 'application/json' })
-            res.end(JSON.stringify({ method: req.method, body: JSON.parse(body) }))
+            res.end(JSON.stringify({ method: req.method, body: JSON.parse(body) as object }))
           })
         })
 

package/src/read-post-body.ts

@@ -9,7 +9,7 @@ export const readPostBodyRaw = async (incomingMessage: IncomingMessage) => {
   let body = ''
   await new Promise<void>((resolve, reject) => {
     incomingMessage.on('readable', () => {
-      const data = incomingMessage.read()
+      const data = incomingMessage.read() as string
       if (data) {
         body += data
       }

package/src/rest-service.integration.spec.ts

@@ -84,8 +84,8 @@ describe('@furystack/rest-service inregration tests', () => {
       })
       expect(result.ok).toBe(false)
       expect(result.status).toBe(404)
-      const responseText = await result.json()
-      expect(responseText).toEqual({ error: 'Content not found' })
+      const response = (await result.json()) as { error: string }
+      expect(response).toEqual({ error: 'Content not found' })
     })
   })
 
@@ -94,8 +94,8 @@ describe('@furystack/rest-service inregration tests', () => {
       const result = await fetch(PathHelper.joinPaths(apiUrl, 'currentUser'))
       expect(result.ok).toBe(false)
       expect(result.status).toBe(401)
-      const responseText = await result.json()
-      expect(responseText).toEqual({ error: 'unauthorized' })
+      const response = (await result.json()) as { error: string }
+      expect(response).toEqual({ error: 'unauthorized' })
     })
   })
 
@@ -104,8 +104,8 @@ describe('@furystack/rest-service inregration tests', () => {
       const result = await fetch(PathHelper.joinPaths(apiUrl, 'currentUser'))
       expect(result.ok).toBe(false)
       expect(result.status).toBe(401)
-      const responseText = await result.json()
-      expect(responseText).toEqual({ error: 'unauthorized' })
+      const response = (await result.json()) as { error: string }
+      expect(response).toEqual({ error: 'unauthorized' })
     })
   })
 
@@ -113,7 +113,7 @@ describe('@furystack/rest-service inregration tests', () => {
     await usingAsync(await createIntegrationApi(), async ({ apiUrl }) => {
       const response = await fetch(PathHelper.joinPaths(apiUrl, 'isAuthenticated'))
       expect(response.status).toBe(200)
-      const result = await response.json()
+      const result = (await response.json()) as { isAuthenticated: boolean }
       expect(result).toEqual({ isAuthenticated: false })
     })
   })
@@ -123,7 +123,7 @@ describe('@furystack/rest-service inregration tests', () => {
       console.log('apiUrl', apiUrl)
       const response = await fetch(PathHelper.joinPaths(apiUrl, `testQuery?param1=${serializeValue('foo')}`))
       expect(response.status).toBe(200)
-      const result = await response.json()
+      const result = (await response.json()) as { param1Value: string }
       expect(result).toEqual({ param1Value: 'foo' })
     })
   })
@@ -132,7 +132,7 @@ describe('@furystack/rest-service inregration tests', () => {
     await usingAsync(await createIntegrationApi(), async ({ apiUrl }) => {
       const response = await fetch(PathHelper.joinPaths(apiUrl, 'testUrlParams/bar'))
       expect(response.status).toBe(200)
-      const result = await response.json()
+      const result = (await response.json()) as { urlParamValue: string }
       expect(result).toEqual({ urlParamValue: 'bar' })
     })
   })
@@ -144,7 +144,7 @@ describe('@furystack/rest-service inregration tests', () => {
         body: JSON.stringify({ value: 'baz' }),
       })
       expect(response.status).toBe(200)
-      const result = await response.json()
+      const result = (await response.json()) as { bodyValue: string; body2Value: string }
       expect(result).toEqual({ bodyValue: 'baz', body2Value: 'baz' })
     })
   })

package/src/server-response-extensions.spec.ts

@@ -1,8 +1,8 @@
-import { Socket } from 'net'
 import { IncomingMessage, ServerResponse } from 'http'
-import './server-response-extensions'
+import { Socket } from 'net'
+import { describe, expect, it, vi } from 'vitest'
 import { BypassResult, JsonResult, PlainTextResult } from './request-action-implementation.js'
-import { describe, it, expect, vi } from 'vitest'
+import './server-response-extensions'
 
 describe('ServerResponse extensions', () => {
   describe('sendActionResult', () => {
@@ -16,9 +16,9 @@ describe('ServerResponse extensions', () => {
       const jsonValue = { value: Math.random() }
       const socket = new Socket()
       const msg = new ServerResponse(new IncomingMessage(socket))
-      msg.writeHead = vi.fn() as any
+      msg.writeHead = vi.fn()
       await new Promise<void>((done) => {
-        msg.end = ((chunk: any) => {
+        msg.end = ((chunk: unknown) => {
           expect(chunk).toBe(JSON.stringify(jsonValue))
           expect(msg.writeHead).toBeCalledWith(200, { 'Content-Type': 'application/json' })
           done()
@@ -33,7 +33,7 @@ describe('ServerResponse extensions', () => {
       const socket = new Socket()
       const msg = new ServerResponse(new IncomingMessage(socket))
       await new Promise<void>((done) => {
-        msg.writeHead = vi.fn() as any
+        msg.writeHead = vi.fn()
         msg.end = ((chunk: any) => {
           expect(chunk).toBe(textValue)
           expect(msg.writeHead).toBeCalledWith(200, { 'Content-Type': 'plain/text' })
@@ -47,8 +47,8 @@ describe('ServerResponse extensions', () => {
     it('Should skip sending on BypassResult', () => {
       const socket = new Socket()
       const msg = new ServerResponse(new IncomingMessage(socket))
-      msg.writeHead = vi.fn() as any
-      msg.end = vi.fn() as any
+      msg.writeHead = vi.fn()
+      msg.end = vi.fn()
 
       msg.sendActionResult(BypassResult())
       expect(msg.writeHead).not.toBeCalled()

package/src/server-response-extensions.ts

@@ -20,7 +20,7 @@ declare module 'http' {
 
 http.ServerResponse.prototype.sendActionResult = function <T>(options: ActionResult<T>) {
   if (typeof options.chunk === 'object') {
-    options.chunk = JSON.stringify(options.chunk) as any
+    options.chunk = JSON.stringify(options.chunk) as T
   }
   if (typeof options.chunk === 'string' && options.chunk === 'BypassResult') {
     return

package/src/swagger/generate-swagger-json.spec.ts

@@ -1,16 +1,17 @@
-import type { ApiEndpointDefinition, ParameterObject, ReferenceObject, ResponseObject } from '@furystack/rest'
+import type { ApiEndpointSchema, ParameterObject, ReferenceObject, ResponseObject } from '@furystack/rest'
 import { describe, expect, it } from 'vitest'
 import { generateSwaggerJsonFromApiSchema } from './generate-swagger-json.js'
 
 describe('generateSwaggerJsonFromApiSchema', () => {
   it('Should generate a basic Swagger document with correct OpenAPI structure', () => {
-    const api: Record<string, ApiEndpointDefinition> = {
-      '/api/test': {
-        method: 'GET',
-        path: '/api/test',
-        isAuthenticated: false,
-        schemaName: 'Test',
-        schema: { type: 'object', properties: { id: { type: 'string' } } },
+    const api: ApiEndpointSchema['endpoints'] = {
+      GET: {
+        '/api/test': {
+          path: '/api/test',
+          isAuthenticated: false,
+          schemaName: 'Test',
+          schema: { type: 'object', properties: { id: { type: 'string' } } },
+        },
       },
     }
 
@@ -30,20 +31,20 @@ describe('generateSwaggerJsonFromApiSchema', () => {
   })
 
   it('Should convert API endpoints to OpenAPI paths correctly', () => {
-    const api: Record<string, ApiEndpointDefinition> = {
-      '/api/users': {
-        method: 'GET',
-        path: '/api/users',
-        isAuthenticated: true,
-        schemaName: 'UserCollection',
-        schema: { type: 'array', items: { type: 'object' } },
-      },
-      '/api/users/:id': {
-        method: 'GET',
-        path: '/api/users/:id',
-        isAuthenticated: true,
-        schemaName: 'User',
-        schema: { type: 'object', properties: { id: { type: 'string' } } },
+    const api: ApiEndpointSchema['endpoints'] = {
+      GET: {
+        '/api/users': {
+          path: '/api/users',
+          isAuthenticated: true,
+          schemaName: 'UserCollection',
+          schema: { type: 'array', items: { type: 'object' } },
+        },
+        '/api/users/:id': {
+          path: '/api/users/:id',
+          isAuthenticated: true,
+          schemaName: 'User',
+          schema: { type: 'object', properties: { id: { type: 'string' } } },
+        },
       },
     }
 
@@ -63,13 +64,14 @@ describe('generateSwaggerJsonFromApiSchema', () => {
   })
 
   it('Should extract path parameters correctly', () => {
-    const api: Record<string, ApiEndpointDefinition> = {
-      '/api/users/:userId/posts/:postId': {
-        method: 'GET',
-        path: '/api/users/:userId/posts/:postId',
-        isAuthenticated: false,
-        schemaName: 'Post',
-        schema: { type: 'object' },
+    const api: ApiEndpointSchema['endpoints'] = {
+      GET: {
+        '/api/users/:userId/posts/:postId': {
+          path: '/api/users/:userId/posts/:postId',
+          isAuthenticated: false,
+          schemaName: 'Post',
+          schema: { type: 'object' },
+        },
       },
     }
 
@@ -87,48 +89,52 @@ describe('generateSwaggerJsonFromApiSchema', () => {
   })
 
   it('Should handle different HTTP methods correctly', () => {
-    const api: Record<string, ApiEndpointDefinition> = {
-      '/api/resource-get': {
-        method: 'GET',
-        path: '/api/resource-get',
-        isAuthenticated: false,
-        schemaName: 'Resource',
-        schema: { type: 'object' },
+    const api: ApiEndpointSchema['endpoints'] = {
+      GET: {
+        '/api/resource': {
+          path: '/api/resource',
+          isAuthenticated: false,
+          schemaName: 'Resource',
+          schema: { type: 'object' },
+        },
       },
-      '/api/resource-post': {
-        method: 'POST',
-        path: '/api/resource-post',
-        isAuthenticated: true,
-        schemaName: 'ResourceInput',
-        schema: { type: 'object' },
+      POST: {
+        '/api/resource': {
+          path: '/api/resource',
+          isAuthenticated: true,
+          schemaName: 'ResourceInput',
+          schema: { type: 'object' },
+        },
       },
-      '/api/resource-put/:id': {
-        method: 'PUT',
-        path: '/api/resource-put/:id',
-        isAuthenticated: true,
-        schemaName: 'ResourceUpdate',
-        schema: { type: 'object' },
+      PUT: {
+        '/api/resource/:id': {
+          path: '/api/resource/:id',
+          isAuthenticated: true,
+          schemaName: 'ResourceUpdate',
+          schema: { type: 'object' },
+        },
       },
-      '/api/resource-delete/:id': {
-        method: 'DELETE',
-        path: '/api/resource-delete/:id',
-        isAuthenticated: true,
-        schemaName: 'ResourceDelete',
-        schema: { type: 'object' },
+      DELETE: {
+        '/api/resource/:id': {
+          path: '/api/resource/:id',
+          isAuthenticated: true,
+          schemaName: 'ResourceDelete',
+          schema: { type: 'object' },
+        },
       },
     }
 
     const result = generateSwaggerJsonFromApiSchema({ api })
 
-    // Check multiple methods
-    expect(result.paths?.['/api/resource-get'].get).toBeDefined()
-    expect(result.paths?.['/api/resource-post'].post).toBeDefined()
-    expect(result.paths?.['/api/resource-put/{id}'].put).toBeDefined()
-    expect(result.paths?.['/api/resource-delete/{id}'].delete).toBeDefined()
+    // Check multiple methods on same path
+    expect(result.paths?.['/api/resource'].get).toBeDefined()
+    expect(result.paths?.['/api/resource'].post).toBeDefined()
+    expect(result.paths?.['/api/resource/{id}'].put).toBeDefined()
+    expect(result.paths?.['/api/resource/{id}'].delete).toBeDefined()
 
     // Verify security is applied correctly based on isAuthenticated
-    expect(result.paths?.['/api/resource-get'].get?.security).toEqual([])
-    expect(result.paths?.['/api/resource-post'].post?.security).toEqual([{ cookieAuth: [] }])
+    expect(result.paths?.['/api/resource'].get?.security).toEqual([])
+    expect(result.paths?.['/api/resource'].post?.security).toEqual([{ cookieAuth: [] }])
   })
 
   it('Should include schemas in components', () => {
@@ -141,13 +147,14 @@ describe('generateSwaggerJsonFromApiSchema', () => {
       },
     }
 
-    const api: Record<string, ApiEndpointDefinition> = {
-      '/api/test': {
-        method: 'GET',
-        path: '/api/test',
-        isAuthenticated: false,
-        schemaName: 'TestModel',
-        schema: testSchema,
+    const api: ApiEndpointSchema['endpoints'] = {
+      GET: {
+        '/api/test': {
+          path: '/api/test',
+          isAuthenticated: false,
+          schemaName: 'TestModel',
+          schema: testSchema,
+        },
       },
     }
 
@@ -158,13 +165,14 @@ describe('generateSwaggerJsonFromApiSchema', () => {
   })
 
   it('Should handle responses with correct status codes and content types', () => {
-    const api: Record<string, ApiEndpointDefinition> = {
-      '/api/test': {
-        method: 'GET',
-        path: '/api/test',
-        isAuthenticated: false,
-        schemaName: 'Test',
-        schema: { type: 'object' },
+    const api: ApiEndpointSchema['endpoints'] = {
+      GET: {
+        '/api/test': {
+          path: '/api/test',
+          isAuthenticated: false,
+          schemaName: 'Test',
+          schema: { type: 'object' },
+        },
       },
     }
 
@@ -186,13 +194,14 @@ describe('generateSwaggerJsonFromApiSchema', () => {
   })
 
   it('Should use empty path object if it does not exist - for code coverage', () => {
-    const api: Record<string, ApiEndpointDefinition> = {
-      '/api/test': {
-        method: 'GET',
-        path: '/api/test',
-        isAuthenticated: false,
-        schemaName: 'Test',
-        schema: { type: 'object' },
+    const api: ApiEndpointSchema['endpoints'] = {
+      GET: {
+        '/api/test': {
+          path: '/api/test',
+          isAuthenticated: false,
+          schemaName: 'Test',
+          schema: { type: 'object' },
+        },
       },
     }
 
@@ -203,13 +212,14 @@ describe('generateSwaggerJsonFromApiSchema', () => {
   })
 
   it('Should handle endpoints without schemas', () => {
-    const api: Record<string, ApiEndpointDefinition> = {
-      '/api/no-schema': {
-        method: 'GET',
-        path: '/api/no-schema',
-        isAuthenticated: false,
-        schemaName: 'EmptySchema',
-        schema: null as any,
+    const api: ApiEndpointSchema['endpoints'] = {
+      GET: {
+        '/api/no-schema': {
+          path: '/api/no-schema',
+          isAuthenticated: false,
+          schemaName: 'EmptySchema',
+          schema: null as unknown,
+        },
       },
     }
 
@@ -221,13 +231,14 @@ describe('generateSwaggerJsonFromApiSchema', () => {
   })
 
   it('Should use operationId based on method and path', () => {
-    const api: Record<string, ApiEndpointDefinition> = {
-      '/api/users/:id/profile': {
-        method: 'GET',
-        path: '/api/users/:id/profile',
-        isAuthenticated: false,
-        schemaName: 'UserProfile',
-        schema: { type: 'object' },
+    const api: ApiEndpointSchema['endpoints'] = {
+      GET: {
+        '/api/users/:id/profile': {
+          path: '/api/users/:id/profile',
+          isAuthenticated: false,
+          schemaName: 'UserProfile',
+          schema: { type: 'object' },
+        },
       },
     }