spiceflow 1.4.1 → 1.5.0

package/src/client/index.ts

@@ -2,6 +2,7 @@
 /* eslint-disable no-case-declarations */
 /* eslint-disable prefer-const */
 import type { Spiceflow } from '../spiceflow.js'
+import superjson from 'superjson'
 import { EventSourceParserStream } from 'eventsource-parser/stream'
 
 import type { SpiceflowClient } from './types.js'
@@ -161,17 +162,17 @@ export async function* streamSSEResponse(
     const { done, value: event } = await reader.read()
     if (done) break
     if (event?.event === 'error') {
-      throw new SpiceflowFetchError(500, event.data)
+      throw new SpiceflowFetchError(500, superjsonDeserialize(event.data))
     }
     if (event) {
-      yield tryParsingJson(event.data)
+      yield tryParsingSSEJson(event.data)
     }
   }
 }
 
-function tryParsingJson(data: string): any {
+function tryParsingSSEJson(data: string): any {
   try {
-    return JSON.parse(data)
+    return superjsonDeserialize(JSON.parse(data))
   } catch (error) {
     return null
   }
@@ -407,6 +408,7 @@ const createProxy = (
 
             case 'application/json':
               data = await response.json()
+              data = superjsonDeserialize(data)
               break
             case 'application/octet-stream':
               data = await response.arrayBuffer()
@@ -432,7 +434,7 @@ const createProxy = (
               response.status,
               data || 'Unknown error',
             )
-            console.trace({ error, data })
+            // console.trace({ error, data })
             data = null
           }
 
@@ -477,3 +479,14 @@ export const createSpiceflowClient = <
 
   return createProxy('http://e.ly', config, [], domain)
 }
+
+function superjsonDeserialize(data: any) {
+  if (data?.__superjsonMeta) {
+    const { __superjsonMeta, ...rest } = data
+    return superjson.deserialize({
+      json: rest,
+      meta: __superjsonMeta,
+    })
+  }
+  return data
+}

package/src/client.test.ts

@@ -1,9 +1,9 @@
 import { z } from 'zod'
 import { createSpiceflowClient } from './client/index.js'
-import { Spiceflow, t } from './spiceflow.js'
+import { Spiceflow } from './spiceflow.js'
+import { Type as t } from '@sinclair/typebox'
 
 import { describe, expect, it } from 'vitest'
-
 const app = new Spiceflow()
   .get('/', () => 'a')
   .post('/', () => 'a')
@@ -11,11 +11,11 @@ const app = new Spiceflow()
   .get('/true', () => true)
   .get('/false', () => false)
   .post('/array', async ({ request }) => await request.json(), {
-    body: t.Array(t.String()),
+    body: z.array(z.string()),
   })
   .post('/mirror', async ({ request }) => await request.json())
   .post('/body', async ({ request }) => await request.text(), {
-    body: t.String(),
+    body: z.string(),
   })
   .post('/zodAny', async ({ request }) => await request.json(), {
     body: z.object({ body: z.array(z.any()) }),
@@ -25,9 +25,9 @@ const app = new Spiceflow()
     return { body: body || null }
   })
   .post('/deep/nested/mirror', async ({ request }) => await request.json(), {
-    body: t.Object({
-      username: t.String(),
-      password: t.String(),
+    body: z.object({
+      username: z.string(),
+      password: z.string(),
     }),
   })
   .get('/throws', () => {
@@ -62,8 +62,8 @@ const app = new Spiceflow()
     },
     {
       response: {
-        200: t.Object({
-          x: t.String(),
+        200: z.object({
+          x: z.string(),
         }),
       },
     },
@@ -78,8 +78,8 @@ const app = new Spiceflow()
   .get('/dateObject', () => ({ date: new Date() }))
   .get('/redirect', ({ redirect }) => redirect('http://localhost:8083/true'))
   .post('/redirect', ({ redirect }) => redirect('http://localhost:8083/true'), {
-    body: t.Object({
-      username: t.String(),
+    body: z.object({
+      username: z.string(),
     }),
   })
   // .get('/formdata', () => ({

package/src/context.ts

@@ -82,7 +82,7 @@ export type Context<
 
   request: SpiceflowRequest<Route['body']>
   state: Singleton['state']
-  response?: Route['response']
+  // response?: Route['response']
 }>
 
 // Use to mimic request before mapping route

package/src/cors.ts

@@ -26,6 +26,7 @@ export const cors = (options?: CORSOptions): MiddlewareHandler => {
     allowMethods: ['GET', 'HEAD', 'PUT', 'POST', 'DELETE', 'PATCH'],
     allowHeaders: [],
     exposeHeaders: [],
+    credentials: true,
     cacheAge: 21600 // 6 hours default
   }
   const opts = {

package/src/mcp.test.ts

@@ -195,12 +195,12 @@ describe('MCP Plugin', () => {
         {
           "mimeType": "application/json",
           "name": "GET /goSomething",
-          "uri": "http://localhost:3000/goSomething",
+          "uri": "http://localhost:4000/goSomething",
         },
         {
           "mimeType": "application/json",
           "name": "GET /users",
-          "uri": "http://localhost:3000/users",
+          "uri": "http://localhost:4000/users",
         },
       ]
     `)
@@ -220,22 +220,15 @@ describe('MCP Plugin', () => {
       [
         {
           "mimeType": "application/json",
-          "text": "{
-        "users": [
-          {
-            "id": 1,
-            "name": "John"
-          }
-        ]
-      }",
-          "uri": "http://localhost:3000/users",
+          "text": "{"users":[{"id":1,"name":"John"}]}",
+          "uri": "http://localhost:4000/users",
         },
       ]
     `)
   })
 })
 
-async function getAvailablePort(startPort = 3000, maxRetries = 10) {
+async function getAvailablePort(startPort = 4000, maxRetries = 10) {
   const net = await import('net')
 
   return await new Promise<number>((resolve, reject) => {

package/src/mcp.ts

@@ -9,6 +9,7 @@ import {
 import { zodToJsonSchema } from 'zod-to-json-schema'
 import { SSEServerTransportSpiceflow } from './mcp-transport.js'
 import { isZodSchema, Spiceflow } from './spiceflow.js'
+import { OpenAPIV3 } from 'openapi-types'
 
 function getJsonSchema(schema: any) {
   if (!schema) return undefined

package/src/openapi.test.ts

@@ -159,6 +159,73 @@ test('openapi response', async () => {
     .then((x) => x.json())
   expect(openapiSchema).toMatchInlineSnapshot(`
     {
+      "__superjsonMeta": {
+        "values": {
+          "paths./addBody.patch.responses.200.content.application/json.schema.items": [
+            "undefined",
+          ],
+          "paths./addBody.patch.responses.200.content.application/json.schema.patternProperties": [
+            "undefined",
+          ],
+          "paths./addBody.patch.responses.200.content.application/json.schema.required": [
+            "undefined",
+          ],
+          "paths./formWithSchemaForm.post.responses.200.content.multipart/form-data.schema.items": [
+            "undefined",
+          ],
+          "paths./formWithSchemaForm.post.responses.200.content.multipart/form-data.schema.patternProperties": [
+            "undefined",
+          ],
+          "paths./one/ids/{id}.get.parameters.0.description": [
+            "undefined",
+          ],
+          "paths./one/ids/{id}.get.parameters.0.examples": [
+            "undefined",
+          ],
+          "paths./one/ids/{id}.get.responses.404.content.application/json.schema.items": [
+            "undefined",
+          ],
+          "paths./one/ids/{id}.get.responses.404.content.application/json.schema.patternProperties": [
+            "undefined",
+          ],
+          "paths./queryParams.get.parameters.0.description": [
+            "undefined",
+          ],
+          "paths./queryParams.get.parameters.0.examples": [
+            "undefined",
+          ],
+          "paths./queryParams.get.responses.200.content.application/json.schema.items": [
+            "undefined",
+          ],
+          "paths./queryParams.get.responses.200.content.application/json.schema.patternProperties": [
+            "undefined",
+          ],
+          "paths./queryParams.get.responses.200.content.application/json.schema.required": [
+            "undefined",
+          ],
+          "paths./queryParams.post.responses.200.content.application/json.schema.items": [
+            "undefined",
+          ],
+          "paths./queryParams.post.responses.200.content.application/json.schema.patternProperties": [
+            "undefined",
+          ],
+          "paths./queryParams.post.responses.200.content.application/json.schema.required": [
+            "undefined",
+          ],
+          "paths./streamWithSchema.get.responses.200.content.application/json.schema.items": [
+            "undefined",
+          ],
+          "paths./streamWithSchema.get.responses.200.content.application/json.schema.patternProperties": [
+            "undefined",
+          ],
+          "paths./two/ids/{id}.get.parameters.0.description": [
+            "undefined",
+          ],
+          "paths./two/ids/{id}.get.parameters.0.examples": [
+            "undefined",
+          ],
+        },
+      },
       "components": {
         "schemas": {},
       },
@@ -196,11 +263,14 @@ test('openapi response', async () => {
                 "content": {
                   "application/json": {
                     "schema": {
+                      "items": null,
+                      "patternProperties": null,
                       "properties": {
                         "name": {
                           "type": "string",
                         },
                       },
+                      "required": null,
                       "type": "object",
                     },
                   },
@@ -226,6 +296,8 @@ test('openapi response', async () => {
                 "content": {
                   "multipart/form-data": {
                     "schema": {
+                      "items": null,
+                      "patternProperties": null,
                       "properties": {
                         "age": {
                           "type": "string",
@@ -259,6 +331,8 @@ test('openapi response', async () => {
           "get": {
             "parameters": [
               {
+                "description": null,
+                "examples": null,
                 "in": "path",
                 "name": "id",
                 "required": true,
@@ -282,6 +356,8 @@ test('openapi response', async () => {
                 "content": {
                   "application/json": {
                     "schema": {
+                      "items": null,
+                      "patternProperties": null,
                       "properties": {
                         "message": {
                           "type": "string",
@@ -333,6 +409,8 @@ test('openapi response', async () => {
           "get": {
             "parameters": [
               {
+                "description": null,
+                "examples": null,
                 "in": "query",
                 "name": "name",
                 "required": true,
@@ -346,11 +424,14 @@ test('openapi response', async () => {
                 "content": {
                   "application/json": {
                     "schema": {
+                      "items": null,
+                      "patternProperties": null,
                       "properties": {
                         "name": {
                           "type": "string",
                         },
                       },
+                      "required": null,
                       "type": "object",
                     },
                   },
@@ -395,11 +476,14 @@ test('openapi response', async () => {
                 "content": {
                   "application/json": {
                     "schema": {
+                      "items": null,
+                      "patternProperties": null,
                       "properties": {
                         "name": {
                           "type": "string",
                         },
                       },
+                      "required": null,
                       "type": "object",
                     },
                   },
@@ -451,6 +535,8 @@ test('openapi response', async () => {
                 "content": {
                   "application/json": {
                     "schema": {
+                      "items": null,
+                      "patternProperties": null,
                       "properties": {
                         "count": {
                           "type": "number",
@@ -483,6 +569,8 @@ test('openapi response', async () => {
           "get": {
             "parameters": [
               {
+                "description": null,
+                "examples": null,
                 "in": "path",
                 "name": "id",
                 "required": true,

package/src/spiceflow.test.ts

@@ -11,6 +11,122 @@ test('works', async () => {
   expect(res.status).toBe(200)
   expect(await res.json()).toEqual('hi')
 })
+test('can encode superjson types', async () => {
+  const app = new Spiceflow().post('/superjson', () => {
+    const item = {
+      date: new Date('2025-01-20T18:01:57.852Z'),
+      map: new Map([['a', 1]]),
+      set: new Set([1, 2, 3]),
+      bigint: BigInt(123),
+    }
+    return { items: Array(2).fill(item) }
+  })
+  const res = await app.handle(
+    new Request('http://localhost/superjson', { method: 'POST' }),
+  )
+  expect(res.status).toBe(200)
+  const client = createSpiceflowClient(app)
+  expect(await client.superjson.post().then((x) => x.data))
+    .toMatchInlineSnapshot(`
+      {
+        "items": [
+          {
+            "bigint": 123n,
+            "date": 2025-01-20T18:01:57.852Z,
+            "map": Map {
+              "a" => 1,
+            },
+            "set": Set {
+              1,
+              2,
+              3,
+            },
+          },
+          {
+            "bigint": 123n,
+            "date": 2025-01-20T18:01:57.852Z,
+            "map": Map {
+              "a" => 1,
+            },
+            "set": Set {
+              1,
+              2,
+              3,
+            },
+          },
+        ],
+      }
+    `)
+  expect(await res.json()).toMatchInlineSnapshot(`
+    {
+      "__superjsonMeta": {
+        "referentialEqualities": {
+          "items.0": [
+            "items.1",
+          ],
+        },
+        "values": {
+          "items.0.bigint": [
+            "bigint",
+          ],
+          "items.0.date": [
+            "Date",
+          ],
+          "items.0.map": [
+            "map",
+          ],
+          "items.0.set": [
+            "set",
+          ],
+          "items.1.bigint": [
+            "bigint",
+          ],
+          "items.1.date": [
+            "Date",
+          ],
+          "items.1.map": [
+            "map",
+          ],
+          "items.1.set": [
+            "set",
+          ],
+        },
+      },
+      "items": [
+        {
+          "bigint": "123",
+          "date": "2025-01-20T18:01:57.852Z",
+          "map": [
+            [
+              "a",
+              1,
+            ],
+          ],
+          "set": [
+            1,
+            2,
+            3,
+          ],
+        },
+        {
+          "bigint": "123",
+          "date": "2025-01-20T18:01:57.852Z",
+          "map": [
+            [
+              "a",
+              1,
+            ],
+          ],
+          "set": [
+            1,
+            2,
+            3,
+          ],
+        },
+      ],
+    }
+  `)
+})
 test('dynamic route', async () => {
   const res = await new Spiceflow()
     .post('/ids/:id', () => 'hi')
@@ -311,7 +427,7 @@ test('validate body works, request fails', async () => {
     )
   expect(res.status).toBe(422)
   expect(await res.text()).toMatchInlineSnapshot(
-    `"{"message":"data must have required property 'requiredField'"}"`,
+    `"{"code":"VALIDATION","status":422,"message":"data must have required property 'requiredField'"}"`,
   )
 })
 
@@ -578,7 +694,9 @@ test('errors inside basPath works', async () => {
     expect(onErrorTriggered).toEqual(['root', 'two', 'nested'])
     expect(onReqTriggered).toEqual(['root', 'two', 'nested'])
     expect(res.status).toBe(500)
-    expect(await res.text()).toMatchInlineSnapshot(`"{"message":"error message"}"`)
+    expect(await res.text()).toMatchInlineSnapshot(
+      `"{"message":"error message"}"`,
+    )
     // expect(await res.json()).toEqual('nested'))
   }
 })

package/src/spiceflow.ts

@@ -1,8 +1,5 @@
-import { Type } from '@sinclair/typebox'
-
-export { Type as t }
-
 import addFormats from 'ajv-formats'
+import superjson from 'superjson'
 import {
   ComposeSpiceflowResponse,
   ContentType,
@@ -35,6 +32,7 @@ import { zodToJsonSchema } from 'zod-to-json-schema'
 import { Context, MiddlewareContext } from './context.js'
 import { isProduction, ValidationError } from './error.js'
 import { isAsyncIterable, isResponse, redirect } from './utils.js'
+import { json } from 'stream/consumers'
 
 const ajv = (addFormats.default || addFormats)(
   new (Ajv.default || Ajv)({ useDefaults: true }),
@@ -777,7 +775,10 @@ export class Spiceflow<
 
       let status = err?.status ?? 500
       res ||= new Response(
-        JSON.stringify({ message: err?.message || 'Internal Server Error' }),
+        superjsonSerialize({
+          ...err,
+          message: err?.message || 'Internal Server Error',
+        }),
         {
           status,
           headers: {
@@ -922,7 +923,7 @@ export class Spiceflow<
         error(error) {
           console.error(error)
           return new Response(
-            JSON.stringify({ message: 'Internal Server Error' }),
+            superjsonSerialize({ message: 'Internal Server Error' }),
             {
               status: 500,
             },
@@ -1002,7 +1003,7 @@ export class Spiceflow<
       } catch (error) {
         console.error('Error handling request:', error)
         res.statusCode = 500
-        res.end(JSON.stringify({ message: 'Internal Server Error' }))
+        res.end(superjsonSerialize({ message: 'Internal Server Error' }))
       }
     })
 
@@ -1054,6 +1055,7 @@ export class Spiceflow<
             // 1. return() allows for cleanup in finally blocks
             // 2. throw() would trigger error handling which isn't needed for normal aborts
             // 3. return() is the more graceful way to stop iteration
+
             if ('return' in generator) {
               try {
                 await generator.return(undefined)
@@ -1072,7 +1074,9 @@ export class Spiceflow<
           if (init?.value !== undefined && init?.value !== null)
             controller.enqueue(
               Buffer.from(
-                'event: message\ndata: ' + JSON.stringify(init.value) + '\n\n',
+                'event: message\ndata: ' +
+                  superjsonSerialize(init.value, false) +
+                  '\n\n',
               ),
             )
 
@@ -1083,7 +1087,9 @@ export class Spiceflow<
 
               controller.enqueue(
                 Buffer.from(
-                  'event: message\ndata: ' + JSON.stringify(chunk) + '\n\n',
+                  'event: message\ndata: ' +
+                    superjsonSerialize(chunk, false) +
+                    '\n\n',
                 ),
               )
             }
@@ -1096,7 +1102,13 @@ export class Spiceflow<
             controller.enqueue(
               Buffer.from(
                 'event: error\ndata: ' +
-                  JSON.stringify(error.message || error.name || 'Error') +
+                  superjsonSerialize(
+                    {
+                      ...error,
+                      message: error.message || error.name || 'Error',
+                    },
+                    false,
+                  ) +
                   '\n\n',
               ),
             )
@@ -1292,13 +1304,23 @@ export async function turnHandlerResultIntoResponse(
       })
     }
   }
-  return new Response(JSON.stringify(result ?? null, null, 2), {
+
+  return new Response(superjsonSerialize(result), {
     headers: {
       'content-type': 'application/json',
     },
   })
 }
 
+function superjsonSerialize(value: any, indent = false) {
+  // return JSON.stringify(value)
+  const { json, meta } = superjson.serialize(value)
+  if (json && meta) {
+    json['__superjsonMeta'] = meta
+  }
+  return JSON.stringify(json ?? null, null, indent ? 2 : undefined)
+}
+
 export type AnySpiceflow = Spiceflow<any, any, any, any, any, any>
 
 export function isZodSchema(value: unknown): value is ZodType {

package/src/stream.test.ts

@@ -69,8 +69,16 @@ describe('Stream', () => {
 
     const response = await app.handle(req('/')).then((x) => x.text())
 
-    expect(response).toBe(
-      'event: message\ndata: "a"\n\nevent: error\ndata: "an error"\n\n',
+    expect(response).toMatchInlineSnapshot(
+      `
+      "event: message
+      data: "a"
+
+      event: error
+      data: {"message":"an error"}
+
+      "
+    `,
     )
   })
 

package/src/zod.test.ts

@@ -1,8 +1,7 @@
-import { test, describe, expect } from 'vitest'
-import { Type } from '@sinclair/typebox'
+import { expect, test } from 'vitest'
+import { z } from 'zod'
 import { Spiceflow } from './spiceflow.js'
 import { req } from './utils.js'
-import { z } from 'zod'
 
 test('body is parsed as json', async () => {
   let name = ''