spiceflow 1.1.18 → 1.3.0

package/src/types.ts

@@ -2,7 +2,6 @@
 
 import z from 'zod'
 
-
 import type {
   OptionalKind,
   Static,
@@ -25,14 +24,15 @@ import { Spiceflow } from './spiceflow.js'
 
 export type MaybeArray<T> = T | T[]
 export type MaybePromise<T> = T | Promise<T>
+export type MaybePromiseIterable<T> = T | Promise<T> | AsyncIterable<T>
 
 export type ObjectValues<T extends object> = T[keyof T]
 
 type IsPathParameter<Part extends string> = Part extends `:${infer Parameter}`
   ? Parameter
   : Part extends `*`
-    ? '*'
-    : never
+  ? '*'
+  : never
 
 export type GetPathParameter<Path extends string> =
   Path extends `${infer A}/${infer B}`
@@ -68,19 +68,17 @@ export type NeverKey<T> = {
   [K in keyof T]?: T[K]
 } & {}
 
-type IsBothObject<A, B> =
-  A extends Record<string | number | symbol, unknown>
-    ? B extends Record<string | number | symbol, unknown>
-      ? IsClass<A> extends false
-        ? IsClass<B> extends false
-          ? true
-          : false
+type IsBothObject<A, B> = A extends Record<string | number | symbol, unknown>
+  ? B extends Record<string | number | symbol, unknown>
+    ? IsClass<A> extends false
+      ? IsClass<B> extends false
+        ? true
         : false
       : false
     : false
+  : false
 
 type IsClass<V> = V extends abstract new (...args: any) => any ? true : false
-type And<A, B> = A extends true ? (B extends true ? true : false) : false
 
 export type Reconcile<
   A extends Object,
@@ -91,57 +89,57 @@ export type Reconcile<
 > = Stack['length'] extends 16
   ? A
   : Override extends true
+  ? {
+      [key in keyof A as key extends keyof B ? never : key]: A[key]
+    } extends infer Collision
+    ? {} extends Collision
+      ? {
+          [key in keyof B]: IsBothObject<
+            // @ts-ignore trust me bro
+            A[key],
+            B[key]
+          > extends true
+            ? Reconcile<
+                // @ts-ignore trust me bro
+                A[key],
+                B[key],
+                Override,
+                [0, ...Stack]
+              >
+            : B[key]
+        }
+      : Prettify<
+          Collision & {
+            [key in keyof B]: B[key]
+          }
+        >
+    : never
+  : {
+      [key in keyof B as key extends keyof A ? never : key]: B[key]
+    } extends infer Collision
+  ? {} extends Collision
     ? {
-        [key in keyof A as key extends keyof B ? never : key]: A[key]
-      } extends infer Collision
-      ? {} extends Collision
-        ? {
-            [key in keyof B]: IsBothObject<
+        [key in keyof A]: IsBothObject<
+          A[key],
+          // @ts-ignore trust me bro
+          B[key]
+        > extends true
+          ? Reconcile<
               // @ts-ignore trust me bro
-              A[key],
-              B[key]
-            > extends true
-              ? Reconcile<
-                  // @ts-ignore trust me bro
-                  A[key],
-                  B[key],
-                  Override,
-                  [0, ...Stack]
-                >
-              : B[key]
-          }
-        : Prettify<
-            Collision & {
-              [key in keyof B]: B[key]
-            }
-          >
-      : never
-    : {
-          [key in keyof B as key extends keyof A ? never : key]: B[key]
-        } extends infer Collision
-      ? {} extends Collision
-        ? {
-            [key in keyof A]: IsBothObject<
               A[key],
               // @ts-ignore trust me bro
-              B[key]
-            > extends true
-              ? Reconcile<
-                  // @ts-ignore trust me bro
-                  A[key],
-                  // @ts-ignore trust me bro
-                  B[key],
-                  Override,
-                  [0, ...Stack]
-                >
-              : A[key]
-          }
-        : Prettify<
-            {
-              [key in keyof A]: A[key]
-            } & Collision
-          >
-      : never
+              B[key],
+              Override,
+              [0, ...Stack]
+            >
+          : A[key]
+      }
+    : Prettify<
+        {
+          [key in keyof A]: A[key]
+        } & Collision
+      >
+  : never
 
 export interface SingletonBase {
   state: Record<string, unknown>
@@ -181,16 +179,16 @@ export type UnwrapSchema<
 > = undefined extends Schema
   ? unknown
   : Schema extends ZodTypeAny
-    ? z.infer<Schema>
-    : Schema extends TSchema
-      ? Schema extends OptionalField
-        ? Prettify<Partial<Static<Schema>>>
-        : StaticDecode<Schema>
-      : Schema extends string
-        ? Definitions extends Record<Schema, infer NamedSchema>
-          ? NamedSchema
-          : Definitions
-        : unknown
+  ? z.infer<Schema>
+  : Schema extends TSchema
+  ? Schema extends OptionalField
+    ? Prettify<Partial<Static<Schema>>>
+    : StaticDecode<Schema>
+  : Schema extends string
+  ? Definitions extends Record<Schema, infer NamedSchema>
+    ? NamedSchema
+    : Definitions
+  : unknown
 
 export interface UnwrapRoute<
   in out Schema extends InputSchema<any>,
@@ -204,10 +202,13 @@ export interface UnwrapRoute<
         200: UnwrapSchema<Schema['response'], Definitions>
       }
     : Schema['response'] extends Record<number, TypeSchema | string>
-      ? {
-          [k in keyof Schema['response']]: UnwrapSchema<Schema['response'][k], Definitions>
-        }
-      : unknown | void
+    ? {
+        [k in keyof Schema['response']]: UnwrapSchema<
+          Schema['response'][k],
+          Definitions
+        >
+      }
+    : unknown | void
 }
 
 export type LifeCycleEvent =
@@ -223,12 +224,12 @@ export type LifeCycleEvent =
 
 export type ContentType = MaybeArray<
   | (string & {})
-  | 'none'
-  | 'text'
-  | 'json'
-  | 'formdata'
-  | 'urlencoded'
-  | 'arrayBuffer'
+  // | 'none'
+  // | 'text'
+  // | 'json'
+  // | 'formdata'
+  // | 'urlencoded'
+  // | 'arrayBuffer'
   | 'text/plain'
   | 'application/json'
   | 'multipart/form-data'
@@ -296,8 +297,8 @@ export interface MergeSchema<
       ? {}
       : B['response']
     : {} extends B['response']
-      ? A['response']
-      : A['response'] & Omit<B['response'], keyof A['response']>
+    ? A['response']
+    : A['response'] & Omit<B['response'], keyof A['response']>
 }
 
 export type Handler<
@@ -314,31 +315,29 @@ export type Handler<
     : Route['response'][keyof Route['response']]
 >
 
-export type Replace<Original, Target, With> =
-  IsAny<Target> extends true
-    ? Original
-    : Original extends Record<string, unknown>
-      ? {
-          [K in keyof Original]: Original[K] extends Target ? With : Original[K]
-        }
-      : Original extends Target
-        ? With
-        : Original
+export type Replace<Original, Target, With> = IsAny<Target> extends true
+  ? Original
+  : Original extends Record<string, unknown>
+  ? {
+      [K in keyof Original]: Original[K] extends Target ? With : Original[K]
+    }
+  : Original extends Target
+  ? With
+  : Original
 
 export type IsAny<T> = 0 extends 1 & T ? true : false
 
-export type CoExist<Original, Target, With> =
-  IsAny<Target> extends true
-    ? Original
-    : Original extends Record<string, unknown>
-      ? {
-          [K in keyof Original]: Original[K] extends Target
-            ? Original[K] | With
-            : Original[K]
-        }
-      : Original extends Target
-        ? Original | With
-        : Original
+export type CoExist<Original, Target, With> = IsAny<Target> extends true
+  ? Original
+  : Original extends Record<string, unknown>
+  ? {
+      [K in keyof Original]: Original[K] extends Target
+        ? Original[K] | With
+        : Original[K]
+    }
+  : Original extends Target
+  ? Original | With
+  : Original
 
 export type InlineHandler<
   Route extends RouteSchema = {},
@@ -353,7 +352,7 @@ export type InlineHandler<
     : Context<Route, Singleton, Path>,
 ) =>
   | Response
-  | MaybePromise<
+  | MaybePromiseIterable<
       {} extends Route['response']
         ? unknown
         :
@@ -375,12 +374,11 @@ export type OptionalHandler<
     state: {}
   },
   Path extends string = '',
-> =
-  Handler<Route, Singleton, Path> extends (
-    context: infer Context,
-  ) => infer Returned
-    ? (context: Context) => Returned | MaybePromise<void>
-    : never
+> = Handler<Route, Singleton, Path> extends (
+  context: infer Context,
+) => infer Returned
+  ? (context: Context) => Returned | MaybePromise<void>
+  : never
 
 export type AfterHandler<
   in out Route extends RouteSchema = {},
@@ -388,18 +386,17 @@ export type AfterHandler<
     state: {}
   },
   Path extends string = '',
-> =
-  Handler<Route, Singleton, Path> extends (
-    context: infer Context,
-  ) => infer Returned
-    ? (
-        context: Prettify<
-          {
-            response: Route['response']
-          } & Context
-        >,
-      ) => Returned | MaybePromise<void>
-    : never
+> = Handler<Route, Singleton, Path> extends (
+  context: infer Context,
+) => infer Returned
+  ? (
+      context: Prettify<
+        {
+          response: Route['response']
+        } & Context
+      >,
+    ) => Returned | MaybePromise<void>
+  : never
 
 export type MapResponse<
   in out Route extends RouteSchema = {},
@@ -558,6 +555,10 @@ export type DocumentDecoration = Partial<OpenAPIV3.OperationObject> & {
    * Pass `true` to hide route from OpenAPI/swagger document
    * */
   hide?: boolean
+  // 'x-fern-type-name'?: string
+  'x-fern-sdk-group-name'?: string | string[]
+  'x-fern-sdk-method-name'?: string
+  'x-fern-webhook'?: boolean
 }
 
 export type LocalHook<
@@ -579,17 +580,7 @@ export type LocalHook<
 > = (LocalSchema extends {} ? LocalSchema : Isolate<LocalSchema>) &
   Extension & {
     detail?: DocumentDecoration
-    /**
-     * Short for 'Content-Type'
-     *
-     * Available:
-     * - 'none': do not parse body
-     * - 'text' / 'text/plain': parse body as string
-     * - 'json' / 'application/json': parse body as json
-     * - 'formdata' / 'multipart/form-data': parse body as form-data
-     * - 'urlencoded' / 'application/x-www-form-urlencoded: parse body as urlencoded
-     * - 'arraybuffer': parse body as readable stream
-     */
+    bodyType?: ContentType
     type?: ContentType
   }
 
@@ -603,8 +594,6 @@ export interface InternalRoute {
   hooks: LocalHook<any, any, any, any, any, any, any>
 }
 
-
-
 export type AddPrefix<Prefix extends string, T> = {
   [K in keyof T as Prefix extends string ? `${Prefix}${K & string}` : K]: T[K]
 }
@@ -644,8 +633,8 @@ export type CreateClient<
 > = Path extends `/${infer Rest}`
   ? _CreateClient<Rest, Property>
   : Path extends ''
-    ? _CreateClient<'index', Property>
-    : _CreateClient<Path, Property>
+  ? _CreateClient<'index', Property>
+  : _CreateClient<Path, Property>
 
 export type ComposeSpiceflowResponse<Response, Handle> = Handle extends (
   ...a: any[]
@@ -881,10 +870,10 @@ export type HTTPHeaders = Record<string, string> & {
 export type JoinPath<A extends string, B extends string> = `${A}${B extends '/'
   ? '/index'
   : B extends ''
-    ? B
-    : B extends `/${string}`
-      ? B
-      : B}`
+  ? B
+  : B extends `/${string}`
+  ? B
+  : B}`
 
 export type PartialWithRequired<T, K extends keyof T> = Partial<Omit<T, K>> &
   Pick<T, K>