@noego/forge 0.1.25 → 0.1.28

package/dist/client.d.ts

@@ -22,6 +22,17 @@ declare type CallbackHeadersMiddleware = (headers: HeadersObject, next: NextFunc
 
 declare type ContextBuilder = (req: any, res: any) => Record<string, any>;
 
+export declare interface ControllerEvents {
+}
+
+declare type ControllerFactory = (controllerClass: new (...args: any[]) => any) => Promise<unknown> | unknown;
+
+export declare interface ControllerInput {
+}
+
+export declare interface ControllerState {
+}
+
 export declare function createApp<T extends HTMLElement = HTMLElement>(node: T, options: ServerOptions): Promise<void>;
 
 declare const fetch_2: FetchMiddlewareAPI & {
@@ -128,13 +139,14 @@ declare interface IRoute {
     layout?: string[];
     middleware?: string[];
     view: string;
+    controller?: string;
     responses?: Response_2;
     parameters?: Parameter[];
     query?: Parameter[];
     body?: Body_2;
 }
 
-export declare function loadRoute(node: any, base_path: string, route: IRoute, combinedParams: any, urlParams: any, query: any): Promise<void>;
+export declare function loadRoute(node: any, base_path: string, route: IRoute, combinedParams: any, urlParams: any, query: any, controllerFactory?: (controllerClass: new (...args: any[]) => any) => Promise<unknown> | unknown): Promise<void>;
 
 declare function makeUrlParser(pattern: string): (pathname: string) => Record<string, string> | null;
 
@@ -144,6 +156,14 @@ declare type NextFunction = (error?: any) => void;
 
 export declare const page: Writable<IPage>;
 
+export declare interface PageController<S extends ControllerState = ControllerState, I extends ControllerInput = ControllerInput, E extends ControllerEvents = ControllerEvents> {
+    readonly data?: S;
+    readonly input?: I;
+    readonly events?: E;
+    initialize?(loadData: any, route: RouteContext): void | Promise<void>;
+    destroy?(): void;
+}
+
 declare type Parameter = any;
 
 declare type RequestInitMiddleware = ((init: RequestInit, input: RequestInfo | URL) => Promise<RequestInit> | RequestInit) | ((init: RequestInit) => Promise<RequestInit> | RequestInit);
@@ -154,6 +174,13 @@ declare type ResponseData = {
     description: string;
 };
 
+export declare interface RouteContext {
+    params: Record<string, string>;
+    urlParams: Record<string, string>;
+    query: Record<string, string | string[]>;
+    page: IPage;
+}
+
 declare interface ServerOptions {
     development?: boolean;
     viteOptions?: any;
@@ -166,6 +193,8 @@ declare interface ServerOptions {
     assets?: ForgeAssets;
     context_builder?: ContextBuilder;
     middleware_path?: string;
+    /** Optional PageController factory used by the client for each page/layout/controller instantiation. */
+    controller_factory?: ControllerFactory;
 }
 
 export declare function shadowUrl(pattern: string, url: string): any;