@hyperspan/framework 0.0.3 → 0.1.1

package/dist/server.d.ts

@@ -1,65 +1,96 @@
 // Generated by dts-bundle-generator v9.5.1
 
-import Headers$1 from '@mjackson/headers';
+import { TmplHtml } from '@hyperspan/html';
+import { Context, Handler, Hono } from 'hono';
 
-declare class HSTemplate {
-	__hsTemplate: boolean;
-	content: any[];
-	constructor(content: any[]);
+export declare const IS_PROD: boolean;
+/**
+ * Route
+ * Define a route that can handle a direct HTTP request
+ * Route handlers should return a Response or TmplHtml object
+ */
+export declare function createRoute(handler: Handler): HSRoute;
+/**
+ * Component
+ * Define a component or partial with an optional loading placeholder
+ * These can be rendered anywhere inside other templates - even if async.
+ */
+export declare function createComponent(render: () => THSComponentReturn | Promise<THSComponentReturn>): HSComponent;
+/**
+ * Form + route handler
+ * Automatically handles and parses form data
+ *
+ * INITIAL IDEA OF HOW THIS WILL WORK:
+ * ---
+ * 1. Renders component as initial form markup for GET request
+ * 2. Bind form onSubmit function to custom client JS handling
+ * 3. Submits form with JavaScript fetch()
+ * 4. Replaces form content with content from server
+ * 5. All validation and save logic is on the server
+ * 6. Handles any Exception thrown on server as error displayed in client
+ */
+export declare function createForm(renderForm: (data?: any) => THSResponseTypes, schema?: z.ZodSchema | null): HSFormRoute;
+/**
+ * Types
+ */
+export type THSComponentReturn = TmplHtml | string | number | null;
+export type THSResponseTypes = TmplHtml | Response | string | null;
+export declare const HS_DEFAULT_LOADING: () => TmplHtml;
+/**
+ * Route handler helper
+ */
+export declare class HSComponent {
+	_kind: string;
+	_handlers: Record<string, Handler>;
+	_loading?: () => TmplHtml;
+	render: () => THSComponentReturn | Promise<THSComponentReturn>;
+	constructor(render: () => THSComponentReturn | Promise<THSComponentReturn>);
+	loading(fn: () => TmplHtml): this;
 }
-export type THTTPMethod = "GET" | "POST" | "PUT" | "PATCH" | "DELETE";
-declare class HSRequestContext {
-	req: Request;
-	locals: Record<string, any>;
-	headers: Headers$1;
-	route: {
-		params: Record<string, string>;
-		query: URLSearchParams;
-	};
-	constructor(req: Request, params?: Record<string, string>);
-	/**
-	 * Response helper
-	 * Merges a Response object while preserving all headers added in context/middleware
-	 */
-	resMerge(res: Response): Response;
-	/**
-	 * HTML response helper
-	 * Preserves all headers added in context/middleware
-	 */
-	html(content: string, options?: ResponseInit): Response;
+/**
+ * Route handler helper
+ */
+export declare class HSRoute {
+	_kind: string;
+	_handlers: Record<string, Handler>;
+	_methods: null | string[];
+	constructor(handler: Handler);
+}
+/**
+ * Form route handler helper
+ */
+export type THSFormRenderer = (data?: any) => THSResponseTypes;
+export declare class HSFormRoute {
+	_kind: string;
+	_handlers: Record<string, Handler>;
+	_form: THSFormRenderer;
+	_methods: null | string[];
+	_schema: null | z.ZodSchema;
+	constructor(renderForm: THSFormRenderer, schema?: z.ZodSchema | null);
+	getDefaultData(): unknown;
 	/**
-	 * JSON response helper
-	 * Preserves all headers added in context/middleware
+	 * Get form renderer method
 	 */
-	json(content: any, options?: ResponseInit): Response;
-	notFound(msg?: string): Response;
-}
-export type THSRouteHandler = (context: HSRequestContext) => (Response | null | void) | Promise<Response | null | void>;
-declare class HSApp {
-	private _router;
-	private _mw;
-	_defaultRoute: THSRouteHandler;
-	constructor();
-	get(path: string, handler: THSRouteHandler): this;
-	post(path: string, handler: THSRouteHandler): this;
-	put(path: string, handler: THSRouteHandler): this;
-	delete(path: string, handler: THSRouteHandler): this;
-	all(path: string, handler: THSRouteHandler): this;
-	addRoute(methods: THTTPMethod[], path: string, handler: THSRouteHandler): this;
-	defaultRoute(handler: THSRouteHandler): void;
-	private _route;
-	run(req: Request): Promise<Response>;
+	renderForm(data?: any): THSResponseTypes;
+	get(handler: Handler): this;
+	patch(handler: Handler): this;
+	post(handler: Handler): this;
+	put(handler: Handler): this;
+	delete(handler: Handler): this;
 }
-export declare const IS_PROD: boolean;
 /**
  * Run route from file
  */
-export declare function runFileRoute(routeFile: string, context: HSRequestContext): Promise<any>;
+export declare function runFileRoute(RouteModule: any, context: Context): Promise<Response | false>;
 export type THSServerConfig = {
 	appDir: string;
 	staticFileRoot: string;
-	beforeRoutesAdded?: (app: HSApp) => void;
-	afterRoutesAdded?: (app: HSApp) => void;
+	rewrites?: Array<{
+		source: string;
+		destination: string;
+	}>;
+	beforeRoutesAdded?: (app: Hono) => void;
+	afterRoutesAdded?: (app: Hono) => void;
 };
 export type THSRouteMap = {
 	file: string;
@@ -70,22 +101,11 @@ export declare function buildRoutes(config: THSServerConfig): Promise<THSRouteMa
 /**
  * Create and start Bun HTTP server
  */
-export declare function createServer(config: THSServerConfig): Promise<HSApp>;
-/**
- * Build client JS for end users (minimal JS for Hyperspan to work)
- */
-export declare let clientJSFile: string;
-export declare function buildClientJS(): Promise<string>;
-/**
- * Find client CSS file built for end users
- * @TODO: Build this in code here vs. relying on tailwindcss CLI tool from package scripts
- */
-export declare let clientCSSFile: string;
-export declare function buildClientCSS(): Promise<string | undefined>;
+export declare function createServer(config: THSServerConfig): Promise<Hono>;
 /**
  * Streaming HTML Response
  */
-export declare class StreamResponse {
+export declare class StreamResponse extends Response {
 	constructor(iterator: AsyncIterator<unknown>, options?: {});
 }
 /**
@@ -93,17 +113,9 @@ export declare class StreamResponse {
  */
 export declare function createReadableStreamFromAsyncGenerator(output: AsyncGenerator): ReadableStream<any>;
 /**
- * Form route
- * Automatically handles and parses form data
- *
- * 1. Renders component as initial form markup
- * 2. Bind form onSubmit function to custom client JS handling
- * 3. Submits form with JavaScript fetch()
- * 4. Replaces form content with content from server
- * 5. All validation and save logic is on the server
- * 6. Handles any Exception thrown on server as error displayed in client
+ * Normalize URL path
+ * Removes trailing slash and lowercases path
  */
-export type TFormRouteFn = (context: HSRequestContext) => HSTemplate | Response;
-export declare function formRoute(handlerFn: TFormRouteFn): (context: HSRequestContext) => void;
+export declare function normalizePath(urlPath: string): string;
 
 export {};