spiceflow 1.10.0 → 1.11.0

package/src/spiceflow.ts

@@ -1,25 +1,30 @@
-import lodashCloneDeep from 'lodash.clonedeep'
+import { copy } from 'copy-anything'
+
+import { SpiceflowFetchError } from './client/errors.ts'
+import { ValidationError } from './error.ts'
 import {
-    ComposeSpiceflowResponse,
-    ContentType,
-    CreateClient,
-    DefinitionBase,
-    ErrorHandler,
-    HTTPMethod,
-    InlineHandler,
-    InputSchema,
-    IsAny,
-    JoinPath,
-    LocalHook,
-    MetadataBase,
-    MiddlewareHandler,
-    Reconcile,
-    ResolvePath,
-    RouteBase,
-    RouteSchema,
-    SingletonBase,
-    TypeSchema,
-    UnwrapRoute
+  ComposeSpiceflowResponse,
+  ContentType,
+  CreateClient,
+  DefinitionBase,
+  ErrorHandler,
+  ExtractParamsFromPath,
+  GetRequestSchema,
+  HTTPMethod,
+  InlineHandler,
+  InputSchema,
+  IsAny,
+  JoinPath,
+  LocalHook,
+  MetadataBase,
+  MiddlewareHandler,
+  Reconcile,
+  ResolvePath,
+  RouteBase,
+  RouteSchema,
+  SingletonBase,
+  TypeSchema,
+  UnwrapRoute,
 } from './types.ts'
 
 import OriginalRouter from '@medley/router'
@@ -29,7 +34,6 @@ import { StandardSchemaV1 } from '@standard-schema/spec'
 import { IncomingMessage, ServerResponse } from 'node:http'
 import { handleForNode, listenForNode } from 'spiceflow/_node-server'
 import { MiddlewareContext } from './context.ts'
-import { ValidationError } from './error.ts'
 import { superjsonSerialize } from './serialize.ts'
 import { isAsyncIterable, isResponse, redirect } from './utils.ts'
 
@@ -37,7 +41,15 @@ let globalIndex = 0
 
 type AsyncResponse = Response | Promise<Response>
 
-type OnError = (x: { error: any; request: Request }) => AsyncResponse
+export type SpiceflowServerError =
+  | ValidationError
+  | SpiceflowFetchError<number, any>
+  | Error
+
+type OnError = (x: {
+  error: SpiceflowServerError
+  request: Request
+}) => AsyncResponse
 
 type ValidationFunction = (
   value: unknown,
@@ -83,7 +95,8 @@ export class Spiceflow<
     macro: {}
     macroFn: {}
   },
-  const out Routes extends RouteBase = {},
+  const out ClientRoutes extends RouteBase = {},
+  const out RoutePaths extends string = '',
 > {
   private id: number = globalIndex++
   private router: MedleyRouter = new OriginalRouter()
@@ -93,6 +106,16 @@ export class Spiceflow<
   private defaultState: Record<any, any> = {}
   topLevelApp?: AnySpiceflow
 
+  _types = {
+    Prefix: '' as BasePath,
+    ClientRoutes: {} as ClientRoutes,
+    RoutePaths: '' as RoutePaths,
+    Scoped: false as Scoped,
+    Singleton: {} as Singleton,
+    Definitions: {} as Definitions,
+    Metadata: {} as Metadata,
+  }
+
   /** @internal */
   prefix?: string
 
@@ -245,7 +268,8 @@ export class Spiceflow<
     },
     Definitions,
     Metadata,
-    Routes
+    ClientRoutes,
+    RoutePaths
   > {
     this.defaultState[name] = value
     return this as any
@@ -268,16 +292,6 @@ export class Spiceflow<
     this.prefix = options.basePath
   }
 
-  _routes: Routes = {} as any
-
-  _types = {
-    Prefix: '' as BasePath,
-    Scoped: false as Scoped,
-    Singleton: {} as Singleton,
-    Definitions: {} as Definitions,
-    Metadata: {} as Metadata,
-  }
-
   post<
     const Path extends string,
     const LocalSchema extends InputSchema<keyof Definitions['type'] & string>,
@@ -304,12 +318,12 @@ export class Spiceflow<
     Singleton,
     Definitions,
     Metadata,
-    Routes &
+    ClientRoutes &
       CreateClient<
         JoinPath<BasePath, Path>,
         {
           post: {
-            body: Schema['body']
+            request: GetRequestSchema<Schema>
             params: undefined extends Schema['params']
               ? ResolvePath<Path>
               : Schema['params']
@@ -317,7 +331,8 @@ export class Spiceflow<
             response: ComposeSpiceflowResponse<Schema['response'], Handle>
           }
         }
-      >
+      >,
+    RoutePaths | JoinPath<BasePath, Path>
   > {
     this.add({ method: 'POST', path, handler: handler, hooks: hook })
 
@@ -351,12 +366,12 @@ export class Spiceflow<
     Singleton,
     Definitions,
     Metadata,
-    Routes &
+    ClientRoutes &
       CreateClient<
         JoinPath<BasePath, Path>,
         {
           get: {
-            body: Schema['body']
+            request: GetRequestSchema<Schema>
             params: undefined extends Schema['params']
               ? ResolvePath<Path>
               : Schema['params']
@@ -365,7 +380,8 @@ export class Spiceflow<
             response: ComposeSpiceflowResponse<Schema['response'], Handle>
           }
         }
-      >
+      >,
+    RoutePaths | JoinPath<BasePath, Path>
   > {
     this.add({ method: 'GET', path, handler: handler, hooks: hook })
     return this as any
@@ -397,12 +413,12 @@ export class Spiceflow<
     Singleton,
     Definitions,
     Metadata,
-    Routes &
+    ClientRoutes &
       CreateClient<
         JoinPath<BasePath, Path>,
         {
           put: {
-            body: Schema['body']
+            request: GetRequestSchema<Schema>
             params: undefined extends Schema['params']
               ? ResolvePath<Path>
               : Schema['params']
@@ -411,13 +427,80 @@ export class Spiceflow<
             response: ComposeSpiceflowResponse<Schema['response'], Handle>
           }
         }
-      >
+      >,
+    RoutePaths | JoinPath<BasePath, Path>
   > {
     this.add({ method: 'PUT', path, handler: handler, hooks: hook })
 
     return this as any
   }
 
+  route<
+    const Path extends string,
+    const LocalSchema extends InputSchema<keyof Definitions['type'] & string>,
+    const Schema extends UnwrapRoute<LocalSchema, Definitions['type']>,
+    const Handle extends InlineHandler<
+      Schema,
+      Singleton,
+      JoinPath<BasePath, Path>
+    >,
+  >(
+    options: {
+      path: Path
+      method: HTTPMethod | HTTPMethod[]
+      handler: Handle
+    } & LocalHook<
+      LocalSchema,
+      Schema,
+      Singleton,
+      Definitions['error'],
+      Metadata['macro'],
+      JoinPath<BasePath, Path>
+    >,
+  ): Spiceflow<
+    BasePath,
+    Scoped,
+    Singleton,
+    Definitions,
+    Metadata,
+    ClientRoutes &
+      CreateClient<
+        JoinPath<BasePath, Path>,
+        {
+          put: {
+            request: GetRequestSchema<Schema>
+            params: undefined extends Schema['params']
+              ? ResolvePath<Path>
+              : Schema['params']
+            query: Schema['query']
+
+            response: ComposeSpiceflowResponse<Schema['response'], Handle>
+          }
+        }
+      >,
+    RoutePaths | JoinPath<BasePath, Path>
+  > {
+    if (Array.isArray(options.method)) {
+      options.method.map((method) =>
+        this.add({
+          method,
+          path: options.path,
+          handler: options.handler,
+          hooks: options,
+        }),
+      )
+    } else {
+      this.add({
+        method: options.method,
+        path: options.path,
+        handler: options.handler,
+        hooks: options,
+      })
+    }
+
+    return this as any
+  }
+
   patch<
     const Path extends string,
     const LocalSchema extends InputSchema<keyof Definitions['type'] & string>,
@@ -444,12 +527,12 @@ export class Spiceflow<
     Singleton,
     Definitions,
     Metadata,
-    Routes &
+    ClientRoutes &
       CreateClient<
         JoinPath<BasePath, Path>,
         {
           patch: {
-            body: Schema['body']
+            request: GetRequestSchema<Schema>
             params: undefined extends Schema['params']
               ? ResolvePath<Path>
               : Schema['params']
@@ -458,7 +541,8 @@ export class Spiceflow<
             response: ComposeSpiceflowResponse<Schema['response'], Handle>
           }
         }
-      >
+      >,
+    RoutePaths | JoinPath<BasePath, Path>
   > {
     this.add({ method: 'PATCH', path, handler: handler, hooks: hook })
 
@@ -491,12 +575,12 @@ export class Spiceflow<
     Singleton,
     Definitions,
     Metadata,
-    Routes &
+    ClientRoutes &
       CreateClient<
         JoinPath<BasePath, Path>,
         {
           delete: {
-            body: Schema['body']
+            request: GetRequestSchema<Schema>
             params: undefined extends Schema['params']
               ? ResolvePath<Path>
               : Schema['params']
@@ -505,7 +589,8 @@ export class Spiceflow<
             response: ComposeSpiceflowResponse<Schema['response'], Handle>
           }
         }
-      >
+      >,
+    RoutePaths | JoinPath<BasePath, Path>
   > {
     this.add({ method: 'DELETE', path, handler: handler, hooks: hook })
 
@@ -538,12 +623,12 @@ export class Spiceflow<
     Singleton,
     Definitions,
     Metadata,
-    Routes &
+    ClientRoutes &
       CreateClient<
         JoinPath<BasePath, Path>,
         {
           options: {
-            body: Schema['body']
+            request: GetRequestSchema<Schema>
             params: undefined extends Schema['params']
               ? ResolvePath<Path>
               : Schema['params']
@@ -552,7 +637,8 @@ export class Spiceflow<
             response: ComposeSpiceflowResponse<Schema['response'], Handle>
           }
         }
-      >
+      >,
+    RoutePaths | JoinPath<BasePath, Path>
   > {
     this.add({ method: 'OPTIONS', path, handler: handler, hooks: hook })
 
@@ -585,12 +671,12 @@ export class Spiceflow<
     Singleton,
     Definitions,
     Metadata,
-    Routes &
+    ClientRoutes &
       CreateClient<
         JoinPath<BasePath, Path>,
         {
           [method in string]: {
-            body: Schema['body']
+            request: GetRequestSchema<Schema>
             params: undefined extends Schema['params']
               ? ResolvePath<Path>
               : Schema['params']
@@ -599,7 +685,8 @@ export class Spiceflow<
             response: ComposeSpiceflowResponse<Schema['response'], Handle>
           }
         }
-      >
+      >,
+    RoutePaths | JoinPath<BasePath, Path>
   > {
     for (const method of METHODS) {
       this.add({ method, path, handler: handler, hooks: hook })
@@ -634,12 +721,12 @@ export class Spiceflow<
     Singleton,
     Definitions,
     Metadata,
-    Routes &
+    ClientRoutes &
       CreateClient<
         JoinPath<BasePath, Path>,
         {
           head: {
-            body: Schema['body']
+            request: GetRequestSchema<Schema>
             params: undefined extends Schema['params']
               ? ResolvePath<Path>
               : Schema['params']
@@ -648,7 +735,8 @@ export class Spiceflow<
             response: ComposeSpiceflowResponse<Schema['response'], Handle>
           }
         }
-      >
+      >,
+    RoutePaths | JoinPath<BasePath, Path>
   > {
     this.add({ method: 'HEAD', path, handler: handler, hooks: hook })
 
@@ -668,8 +756,10 @@ export class Spiceflow<
         Definitions,
         Metadata,
         BasePath extends ``
-          ? Routes & NewSpiceflow['_routes']
-          : Routes & CreateClient<BasePath, NewSpiceflow['_routes']>
+          ? ClientRoutes & NewSpiceflow['_types']['ClientRoutes']
+          : ClientRoutes &
+              CreateClient<BasePath, NewSpiceflow['_types']['ClientRoutes']>,
+        RoutePaths | NewSpiceflow['_types']['RoutePaths']
       >
   use<const Schema extends RouteSchema>(
     handler: MiddlewareHandler<Schema, Singleton>,
@@ -694,10 +784,10 @@ export class Spiceflow<
     return this
   }
 
-  async handle(
+  handle = async (
     request: Request,
     { state: customState }: { state?: Singleton['state'] } = {},
-  ): Promise<Response> {
+  ): Promise<Response> => {
     let u = new URL(request.url, 'http://localhost')
     const self = this
     let path = u.pathname + u.search
@@ -719,7 +809,7 @@ export class Spiceflow<
     } = route
     const middlewares = appsInScope.flatMap((x) => x.middlewares)
 
-    let state = customState || lodashCloneDeep(defaultState)
+    let state = customState || copy(defaultState)
 
     let content = route?.internalRoute?.hooks?.content
 
@@ -939,14 +1029,15 @@ export class Spiceflow<
     return this.handleForNode(req, res, context)
   }
 
-  async handleForNode(
+  handleForNode = (
     req: IncomingMessage,
     res: ServerResponse,
     context: { state?: Singleton['state'] } = {},
-  ) {
+  ) => {
     return handleForNode(this, req, res, context)
   }
 
+  /* @deprecated */
   async listenForNode(port: number, hostname: string = '0.0.0.0') {
     if (typeof Bun !== 'undefined') {
       console.warn(
@@ -1081,6 +1172,28 @@ export class Spiceflow<
       },
     )
   }
+
+  safePath<
+    const Path extends RoutePaths,
+    const Params extends ExtractParamsFromPath<Path>,
+  >(path: Path, params: Params): string {
+    let result = path as string
+
+    // First, handle all provided parameters
+    if (params && typeof params === 'object') {
+      Object.entries(params).forEach(([key, value]) => {
+        // Handle both required (:key) and optional (:key?) parameters
+        const regex = new RegExp(`:${key}\\??`, 'g')
+        result = result.replace(regex, String(value))
+      })
+    }
+
+    // Then, handle any remaining optional parameters that weren't provided
+    // Replace any remaining :param? with empty string (keeping trailing slash)
+    result = result.replace(/:[\w-]+\?/g, '')
+
+    return result
+  }
 }
 
 const METHODS = [
@@ -1209,7 +1322,7 @@ export async function turnHandlerResultIntoResponse(
   })
 }
 
-export type AnySpiceflow = Spiceflow<any, any, any, any, any, any>
+export type AnySpiceflow = Spiceflow<any, any, any, any, any, any, any>
 
 export function isZodSchema(value: unknown): value is ZodType {
   return (
@@ -1290,5 +1403,5 @@ function parseQuery(queryString: string) {
 }
 
 export function cloneDeep(x) {
-  return lodashCloneDeep(x)
+  return copy(x)
 }

package/src/types.ts

@@ -7,13 +7,8 @@ import type { OpenAPIV3 } from 'openapi-types'
 
 import { ZodTypeAny } from 'zod'
 import type { Context, ErrorContext, MiddlewareContext } from './context.ts'
-import {
-    InternalServerError,
-    ParseError,
-    SPICEFLOW_RESPONSE,
-    ValidationError,
-} from './error.ts'
-import { Spiceflow } from './spiceflow.ts'
+import { SPICEFLOW_RESPONSE, ValidationError } from './error.ts'
+import { AnySpiceflow, Spiceflow } from './spiceflow.ts'
 
 export type MaybeArray<T> = T | T[]
 export type MaybePromise<T> = T | Promise<T>
@@ -154,6 +149,7 @@ export interface MetadataBase {
 
 export type RouteSchema = {
   body?: unknown
+  request?: unknown
   query?: unknown
   params?: unknown
   response?: unknown
@@ -178,11 +174,18 @@ export type UnwrapSchema<
           : Definitions
         : unknown
 
+export type GetRequestSchema<Schema extends InputSchema<any>> =
+  'request' extends keyof Schema
+    ? Schema['request']
+    : 'body' extends keyof Schema
+      ? Schema['body']
+      : undefined
+
 export interface UnwrapRoute<
   in out Schema extends InputSchema<any>,
   in out Definitions extends DefinitionBase['type'] = {},
 > {
-  body: UnwrapSchema<Schema['body'], Definitions>
+  request: UnwrapSchema<GetRequestSchema<Schema>, Definitions>
   query: UnwrapSchema<Schema['query'], Definitions>
   params: UnwrapSchema<Schema['params'], Definitions>
   response: Schema['response'] extends TypeSchema | string
@@ -263,7 +266,11 @@ export type HTTPMethod =
   | 'ALL'
 
 export interface InputSchema<Name extends string = string> {
+  /**
+   * @deprecated The 'body' property is deprecated, use request instead.
+   */
   body?: TypeSchema | Name
+  request?: TypeSchema | Name
   query?: TypeObject | Name
   params?: TypeObject | Name
   response?:
@@ -277,7 +284,9 @@ export interface MergeSchema<
   in out A extends RouteSchema,
   in out B extends RouteSchema,
 > {
-  body: undefined extends A['body'] ? B['body'] : A['body']
+  request: undefined extends GetRequestSchema<A>
+    ? GetRequestSchema<B>
+    : GetRequestSchema<A>
   query: undefined extends A['query'] ? B['query'] : A['query']
   params: undefined extends A['params'] ? B['params'] : A['params']
   response: {} extends A['response']
@@ -511,20 +520,7 @@ export type ErrorHandler<
       // 			error: Readonly<NotFoundError>
       // 		} & NeverKey<Singleton['state']>
       //   >
-      | Prettify<
-          {
-            request: Request
-            code: 'PARSE'
-            error: Readonly<ParseError>
-          } & Singleton['state']
-        >
-      | Prettify<
-          {
-            request: Request
-            code: 'INTERNAL_SERVER_ERROR'
-            error: Readonly<InternalServerError>
-          } & Partial<Singleton['state']>
-        >
+      // Removed ParseError and InternalServerError from here
       | Prettify<
           {
             [K in keyof T]: {
@@ -652,7 +648,7 @@ type _ComposeSpiceflowResponse<Response, Handle> = Prettify<
 >
 
 export type MergeSpiceflowInstances<
-  Instances extends Spiceflow<any, any, any, any, any, any>[] = [],
+  Instances extends AnySpiceflow[] = [],
   Prefix extends string = '',
   Scoped extends boolean = false,
   Singleton extends SingletonBase = {
@@ -669,8 +665,8 @@ export type MergeSpiceflowInstances<
   },
   Routes extends RouteBase = {},
 > = Instances extends [
-  infer Current extends Spiceflow<any, any, any, any, any, any>,
-  ...infer Rest extends Spiceflow<any, any, any, any, any, any>[],
+  infer Current extends AnySpiceflow,
+  ...infer Rest extends AnySpiceflow[],
 ]
   ? Current['_types']['Scoped'] extends true
     ? MergeSpiceflowInstances<
@@ -691,8 +687,8 @@ export type MergeSpiceflowInstances<
         Metadata & Current['_types']['Metadata'],
         Routes &
           (Prefix extends ``
-            ? Current['_routes']
-            : AddPrefix<Prefix, Current['_routes']>)
+            ? Current['_types']['ClientRoutes']
+            : AddPrefix<Prefix, Current['_types']['ClientRoutes']>)
       >
   : Spiceflow<
       Prefix,
@@ -869,3 +865,17 @@ export type JoinPath<A extends string, B extends string> = `${A}${B extends '/'
 
 export type PartialWithRequired<T, K extends keyof T> = Partial<Omit<T, K>> &
   Pick<T, K>
+
+export type GetPathsFromRoutes<Routes extends Record<string, unknown>> =
+  Routes extends Record<infer K, any> ? (K extends string ? K : never) : never
+
+export type ExtractParamsFromPath<Path extends string> =
+  Path extends `${string}:${infer Param}/${infer Rest}`
+    ? Param extends `${infer Name}?`
+      ? { [K in Name]?: string } & ExtractParamsFromPath<`/${Rest}`>
+      : { [K in Param]: string } & ExtractParamsFromPath<`/${Rest}`>
+    : Path extends `${string}:${infer Param}`
+      ? Param extends `${infer Name}?`
+        ? { [K in Name]?: string }
+        : { [K in Param]: string }
+      : {}