@hyperspan/framework 0.0.3 → 0.1.1

package/dist/index.d.ts

@@ -1,50 +1,121 @@
 // Generated by dts-bundle-generator v9.5.1
 
+import { TmplHtml } from '@hyperspan/html';
+import { Context, Handler, Hono } from 'hono';
+
+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;
+}
 /**
- * Template object - used so it will be possible to (eventually) pass down context
+ * Route handler helper
  */
-export declare class HSTemplate {
-	__hsTemplate: boolean;
-	content: any[];
-	constructor(content: any[]);
+export declare class HSRoute {
+	_kind: string;
+	_handlers: Record<string, Handler>;
+	_methods: null | string[];
+	constructor(handler: Handler);
 }
 /**
- * HTML template
+ * Form route handler helper
  */
-export declare function html(strings: TemplateStringsArray, ...values: any[]): HSTemplate;
-export declare namespace html {
-	var raw: (value: string) => HSTemplate;
+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;
+	/**
+	 * Get form renderer method
+	 */
+	renderForm(data?: any): THSResponseTypes;
+	get(handler: Handler): this;
+	patch(handler: Handler): this;
+	post(handler: Handler): this;
+	put(handler: Handler): this;
+	delete(handler: Handler): this;
 }
 /**
- * Render HSTemplate to async generator that streams output to a string
+ * Run route from file
  */
-export declare function renderToStream(template: HSTemplate | string): AsyncGenerator<string>;
+export declare function runFileRoute(RouteModule: any, context: Context): Promise<Response | false>;
+export type THSServerConfig = {
+	appDir: string;
+	staticFileRoot: string;
+	rewrites?: Array<{
+		source: string;
+		destination: string;
+	}>;
+	beforeRoutesAdded?: (app: Hono) => void;
+	afterRoutesAdded?: (app: Hono) => void;
+};
+export type THSRouteMap = {
+	file: string;
+	route: string;
+	params: string[];
+};
+export declare function buildRoutes(config: THSServerConfig): Promise<THSRouteMap[]>;
 /**
- * Render HSTemplate to string (awaits/buffers entire response)
+ * Create and start Bun HTTP server
  */
-export declare function renderToString(template: HSTemplate | string): Promise<string>;
+export declare function createServer(config: THSServerConfig): Promise<Hono>;
 /**
- * Strip extra spacing between HTML tags (used for tests)
+ * Streaming HTML Response
  */
-export declare function compressHTMLString(str: string): string;
+export declare class StreamResponse extends Response {
+	constructor(iterator: AsyncIterator<unknown>, options?: {});
+}
 /**
- * LOL JavaScript...
+ * Does what it says on the tin...
  */
-export declare function _typeOf(obj: any): string;
+export declare function createReadableStreamFromAsyncGenerator(output: AsyncGenerator): ReadableStream<any>;
 /**
- * Client component
+ * Normalize URL path
+ * Removes trailing slash and lowercases path
  */
-export type THSWCState = Record<string, any>;
-export type THSWCSetStateArg = THSWCState | ((state: THSWCState) => THSWCState);
-export type THSWC = {
-	this: THSWC;
-	state: THSWCState | undefined;
-	id: string;
-	setState: (fn: THSWCSetStateArg) => THSWCState;
-	mergeState: (newState: THSWCState) => THSWCState;
-	render: () => any;
-};
-export type THSWCUser = Pick<THSWC, "render"> & Record<string, any>;
-export declare function clientComponent(id: string, wc: THSWCUser): (attrs?: Record<string, string>, state?: Record<string, any>) => HSTemplate;
+export declare function normalizePath(urlPath: string): string;
 
 export {};