@hyperspan/framework 1.0.24 → 1.0.25

package/src/types.ts

@@ -9,18 +9,60 @@ export namespace Hyperspan {
     _config: Hyperspan.Config;
     _routes: Array<Hyperspan.Route>;
     _middleware: Record<Hyperspan.MiddlewareMethod, Array<Hyperspan.MiddlewareFunction>>;
-    use: (middleware: Hyperspan.MiddlewareFunction, opts?: Hyperspan.MiddlewareMethodOptions) => Hyperspan.Server;
-    get: (path: string, handler: Hyperspan.RouteHandler, handlerOptions?: Hyperspan.RouteHandlerOptions) => Hyperspan.Route;
-    post: (path: string, handler: Hyperspan.RouteHandler, handlerOptions?: Hyperspan.RouteHandlerOptions) => Hyperspan.Route;
-    put: (path: string, handler: Hyperspan.RouteHandler, handlerOptions?: Hyperspan.RouteHandlerOptions) => Hyperspan.Route;
-    patch: (path: string, handler: Hyperspan.RouteHandler, handlerOptions?: Hyperspan.RouteHandlerOptions) => Hyperspan.Route;
-    delete: (path: string, handler: Hyperspan.RouteHandler, handlerOptions?: Hyperspan.RouteHandlerOptions) => Hyperspan.Route;
-    options: (path: string, handler: Hyperspan.RouteHandler, handlerOptions?: Hyperspan.RouteHandlerOptions) => Hyperspan.Route;
-    all: (path: string, handler: Hyperspan.RouteHandler, handlerOptions?: Hyperspan.RouteHandlerOptions) => Hyperspan.Route;
-  };
+    use: (
+      middleware: Hyperspan.MiddlewareFunction,
+      opts?: Hyperspan.MiddlewareMethodOptions
+    ) => Hyperspan.Server;
+    get: (
+      path: string,
+      handler: Hyperspan.RouteHandler,
+      handlerOptions?: Hyperspan.RouteHandlerOptions
+    ) => Hyperspan.Route;
+    post: (
+      path: string,
+      handler: Hyperspan.RouteHandler,
+      handlerOptions?: Hyperspan.RouteHandlerOptions
+    ) => Hyperspan.Route;
+    put: (
+      path: string,
+      handler: Hyperspan.RouteHandler,
+      handlerOptions?: Hyperspan.RouteHandlerOptions
+    ) => Hyperspan.Route;
+    patch: (
+      path: string,
+      handler: Hyperspan.RouteHandler,
+      handlerOptions?: Hyperspan.RouteHandlerOptions
+    ) => Hyperspan.Route;
+    delete: (
+      path: string,
+      handler: Hyperspan.RouteHandler,
+      handlerOptions?: Hyperspan.RouteHandlerOptions
+    ) => Hyperspan.Route;
+    options: (
+      path: string,
+      handler: Hyperspan.RouteHandler,
+      handlerOptions?: Hyperspan.RouteHandlerOptions
+    ) => Hyperspan.Route;
+    all: (
+      path: string,
+      handler: Hyperspan.RouteHandler,
+      handlerOptions?: Hyperspan.RouteHandlerOptions
+    ) => Hyperspan.Route;
+  }
 
   export type Plugin = (config: Hyperspan.Config) => Promise<void> | void;
 
+  export type DisableStreamingFn = (
+    context: Hyperspan.Context,
+    options: {
+      hyperspanDisableStreaming: (context: Hyperspan.Context) => boolean;
+    }
+  ) => boolean;
+
+  export type ResponseOptions = {
+    disableStreaming?: DisableStreamingFn;
+  };
+
   export type Config = {
     appDir: string;
     publicDir: string;
@@ -28,9 +70,7 @@ export namespace Hyperspan {
     // For customizing the routes and adding your own...
     beforeRoutesAdded?: (server: Hyperspan.Server) => void;
     afterRoutesAdded?: (server: Hyperspan.Server) => void;
-    responseOptions?: {
-      disableStreaming?: (context: Hyperspan.Context) => boolean;
-    };
+    responseOptions?: ResponseOptions;
   };
 
   export type CookieOptions = {
@@ -51,7 +91,7 @@ export namespace Hyperspan {
     get: (name: string) => string | undefined;
     set: (name: string, value: string, options?: CookieOptions) => void;
     delete: (name: string) => void;
-  }
+  };
 
   export type HSRequest = {
     url: URL;
@@ -84,7 +124,7 @@ export namespace Hyperspan {
     route: RouteConfig;
     req: HSRequest;
     res: HSResponse;
-  };
+  }
 
   export type ClientIslandOptions = {
     ssr?: boolean;
@@ -96,9 +136,7 @@ export namespace Hyperspan {
     path: string;
     params: Record<string, string | undefined>;
     cssImports: string[];
-    responseOptions?: {
-      disableStreaming?: (context: Hyperspan.Context) => boolean;
-    };
+    responseOptions?: ResponseOptions;
   };
 
   export type RouteHandlerReturn =
@@ -117,17 +155,20 @@ export namespace Hyperspan {
   ) => RouteHandlerReturn | Promise<RouteHandlerReturn>;
   export type RouteHandlerOptions = {
     middleware?: Hyperspan.MiddlewareFunction[];
-  }
+  };
 
   // TypeScript inference for typed   route params
   // Source - https://stackoverflow.com/a/78170543
   // Posted by jcalz
   // Retrieved 2025-11-12, License - CC BY-SA 4.0
-  export type RouteParamsParser<T extends string, A = unknown> =
-    T extends `${string}:${infer F}/${infer R}` ? RouteParamsParser<R, A & Record<F, string>> :
-    (A & (T extends `${string}:${infer F}` ? Record<F, string> : unknown)) extends
-    infer U ? { [K in keyof U]: U[K] } : never
-
+  export type RouteParamsParser<
+    T extends string,
+    A = unknown,
+  > = T extends `${string}:${infer F}/${infer R}`
+    ? RouteParamsParser<R, A & Record<F, string>>
+    : A & (T extends `${string}:${infer F}` ? Record<F, string> : unknown) extends infer U
+      ? { [K in keyof U]: U[K] }
+      : never;
 
   /**
    * Next function type for middleware
@@ -147,7 +188,15 @@ export namespace Hyperspan {
     context: Hyperspan.Context,
     next: Hyperspan.NextFunction
   ) => Promise<Response> | Response;
-  export type MiddlewareMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'HEAD' | 'OPTIONS' | '*';
+  export type MiddlewareMethod =
+    | 'GET'
+    | 'POST'
+    | 'PUT'
+    | 'PATCH'
+    | 'DELETE'
+    | 'HEAD'
+    | 'OPTIONS'
+    | '*';
   export type MiddlewareMethodOptions = {
     methods?: Hyperspan.MiddlewareMethod[];
   };
@@ -159,18 +208,45 @@ export namespace Hyperspan {
     _middleware: Record<MiddlewareMethod, Array<Hyperspan.MiddlewareFunction>>;
     _path(): string;
     _methods(): string[];
-    get: (handler: Hyperspan.RouteHandler, handlerOptions?: Hyperspan.RouteHandlerOptions) => Hyperspan.Route;
-    post: (handler: Hyperspan.RouteHandler, handlerOptions?: Hyperspan.RouteHandlerOptions) => Hyperspan.Route;
-    put: (handler: Hyperspan.RouteHandler, handlerOptions?: Hyperspan.RouteHandlerOptions) => Hyperspan.Route;
-    patch: (handler: Hyperspan.RouteHandler, handlerOptions?: Hyperspan.RouteHandlerOptions) => Hyperspan.Route;
-    delete: (handler: Hyperspan.RouteHandler, handlerOptions?: Hyperspan.RouteHandlerOptions) => Hyperspan.Route;
-    options: (handler: Hyperspan.RouteHandler, handlerOptions?: Hyperspan.RouteHandlerOptions) => Hyperspan.Route;
-    all: (handler: Hyperspan.RouteHandler, handlerOptions?: Hyperspan.RouteHandlerOptions) => Hyperspan.Route;
+    get: (
+      handler: Hyperspan.RouteHandler,
+      handlerOptions?: Hyperspan.RouteHandlerOptions
+    ) => Hyperspan.Route;
+    post: (
+      handler: Hyperspan.RouteHandler,
+      handlerOptions?: Hyperspan.RouteHandlerOptions
+    ) => Hyperspan.Route;
+    put: (
+      handler: Hyperspan.RouteHandler,
+      handlerOptions?: Hyperspan.RouteHandlerOptions
+    ) => Hyperspan.Route;
+    patch: (
+      handler: Hyperspan.RouteHandler,
+      handlerOptions?: Hyperspan.RouteHandlerOptions
+    ) => Hyperspan.Route;
+    delete: (
+      handler: Hyperspan.RouteHandler,
+      handlerOptions?: Hyperspan.RouteHandlerOptions
+    ) => Hyperspan.Route;
+    options: (
+      handler: Hyperspan.RouteHandler,
+      handlerOptions?: Hyperspan.RouteHandlerOptions
+    ) => Hyperspan.Route;
+    all: (
+      handler: Hyperspan.RouteHandler,
+      handlerOptions?: Hyperspan.RouteHandlerOptions
+    ) => Hyperspan.Route;
     errorHandler: (handler: Hyperspan.ErrorHandler) => Hyperspan.Route;
-    use: (middleware: Hyperspan.MiddlewareFunction, opts?: Hyperspan.MiddlewareMethodOptions) => Hyperspan.Route;
-    middleware: (middleware: Array<Hyperspan.MiddlewareFunction>, opts?: Hyperspan.MiddlewareMethodOptions) => Hyperspan.Route;
+    use: (
+      middleware: Hyperspan.MiddlewareFunction,
+      opts?: Hyperspan.MiddlewareMethodOptions
+    ) => Hyperspan.Route;
+    middleware: (
+      middleware: Array<Hyperspan.MiddlewareFunction>,
+      opts?: Hyperspan.MiddlewareMethodOptions
+    ) => Hyperspan.Route;
     fetch: (request: Request) => Promise<Response>;
-  };
+  }
 
   /**
    * Action = Form + route handler
@@ -178,8 +254,9 @@ export namespace Hyperspan {
   /** Raw form field values when an action has no schema */
   export type ActionFormValues = Record<string, string | string[]>;
   /** Infer validated action data from an optional schema */
-  export type InferActionData<S extends z.ZodType | undefined> =
-    S extends z.ZodType ? z.output<S> : ActionFormValues;
+  export type InferActionData<S extends z.ZodType | undefined> = S extends z.ZodType
+    ? z.output<S>
+    : ActionFormValues;
   // Form renderer
   export type ActionFormResponse = HSHtml | void | null | Promise<HSHtml | void | null>;
   export type ActionFormProps<S extends z.ZodType | undefined = undefined> = {
@@ -187,7 +264,8 @@ export namespace Hyperspan {
     error?: ZodValidationError;
   };
   export type ActionForm<S extends z.ZodType | undefined = undefined> = (
-    c: Context, props: ActionFormProps<S>
+    c: Context,
+    props: ActionFormProps<S>
   ) => ActionFormResponse;
   // Form handler
   export type ActionFormHandlerReturn = RouteHandlerReturn;
@@ -196,20 +274,28 @@ export namespace Hyperspan {
     error?: ZodValidationError | Error;
   };
   export type ActionFormHandler<S extends z.ZodType | undefined = undefined> = (
-    c: Context, props: ActionFormHandlerProps<S>
+    c: Context,
+    props: ActionFormHandlerProps<S>
   ) => ActionFormHandlerReturn | Promise<ActionFormHandlerReturn>;
   // Action API
   export interface Action<S extends z.ZodType | undefined = undefined> {
     _kind: 'hsAction';
     _config: Partial<Hyperspan.RouteConfig>;
+    _serverConfig?: Hyperspan.Config;
     _path(): string;
     _form: null | ActionForm<S>;
     form(form: ActionForm<S>): Action<S>;
     render: (c: Context, props?: ActionFormProps<S>) => ActionFormResponse;
     post: (handler: ActionFormHandler<S>) => Action<S>;
     errorHandler: (handler: ActionFormHandler<S>) => Action<S>;
-    use: (middleware: Hyperspan.MiddlewareFunction, opts?: Hyperspan.MiddlewareMethodOptions) => Action<S>;
-    middleware: (middleware: Array<Hyperspan.MiddlewareFunction>, opts?: Hyperspan.MiddlewareMethodOptions) => Action<S>;
+    use: (
+      middleware: Hyperspan.MiddlewareFunction,
+      opts?: Hyperspan.MiddlewareMethodOptions
+    ) => Action<S>;
+    middleware: (
+      middleware: Array<Hyperspan.MiddlewareFunction>,
+      opts?: Hyperspan.MiddlewareMethodOptions
+    ) => Action<S>;
     fetch: (request: Request) => Promise<Response>;
   }
 
@@ -225,8 +311,10 @@ export namespace Hyperspan {
      * @param loadScript - A function that loads the module or a string of code to load the module
      * @returns HSHtml Template with the <script type="module"> tag
      */
-    renderScriptTag: (loadScript?: ((module: unknown) => HSHtml | string | void) | string) => HSHtml;
-  }
+    renderScriptTag: (
+      loadScript?: ((module: unknown) => HSHtml | string | void) | string
+    ) => HSHtml;
+  };
 
   /**
    * Zod validation error type. Used in actions and validation middleware.