@farm.js/core 0.1.0-beta.0

package/dist/plugin-BJDf43dc.d.ts

@@ -0,0 +1,165 @@
+type MaybePromise<T> = T | Promise<T>;
+type FarmClientPluginEnforce = "pre" | "post";
+type FarmClientNavigationAction = "push" | "replace" | "pop";
+type FarmClientHydrationMode = "hydrate" | "render";
+interface FarmClientLocation {
+    href: string;
+    pathname: string;
+    search: string;
+    hash: string;
+}
+interface FarmClientPluginRouter {
+    navigate(href: string, options?: Record<string, unknown>): MaybePromise<void>;
+    prefetch?(href: string): MaybePromise<void>;
+    getNavigationState?(): unknown;
+}
+interface FarmClientPluginMetadata {
+    name: string;
+    version?: string;
+}
+interface FarmClientPluginSetupEvent<TPublic = undefined> {
+    plugin: FarmClientPluginMetadata;
+    public: Readonly<TPublic>;
+    router: FarmClientPluginRouter;
+    isDev: boolean;
+    isProd: boolean;
+    deploymentId?: string;
+}
+interface FarmClientPluginStateEvent<TState = unknown, TPublic = undefined> extends FarmClientPluginSetupEvent<TPublic> {
+    state: TState;
+}
+interface FarmClientHydrationSession {
+    container: Element;
+    location: FarmClientLocation;
+    mode: FarmClientHydrationMode;
+    startedAt: number;
+}
+interface FarmClientHydrationEvent<TState = unknown, TPublic = undefined> extends FarmClientPluginStateEvent<TState, TPublic>, FarmClientHydrationSession {
+}
+interface FarmClientHydrationCompleteEvent<TState = unknown, TPublic = undefined> extends FarmClientHydrationEvent<TState, TPublic> {
+    durationMs: number;
+    recovered: boolean;
+}
+interface FarmClientNavigationSession {
+    id: string;
+    from: FarmClientLocation | null;
+    to: FarmClientLocation;
+    action: FarmClientNavigationAction;
+    signal: AbortSignal;
+    startedAt: number;
+    route?: {
+        pattern?: string | null;
+        params?: Record<string, string>;
+    };
+}
+interface FarmClientNavigationEvent<TState = unknown, TPublic = undefined> extends FarmClientPluginStateEvent<TState, TPublic>, FarmClientNavigationSession {
+}
+interface FarmClientNavigationLoadedEvent<TState = unknown, TPublic = undefined> extends FarmClientNavigationEvent<TState, TPublic> {
+    durationMs: number;
+    data?: unknown;
+}
+interface FarmClientNavigationResolvedEvent<TState = unknown, TPublic = undefined> extends FarmClientNavigationEvent<TState, TPublic> {
+    durationMs: number;
+}
+interface FarmClientNavigationErrorEvent<TState = unknown, TPublic = undefined> extends FarmClientNavigationResolvedEvent<TState, TPublic> {
+    error: unknown;
+}
+type FarmClientPluginErrorPhase = "setup" | "hydration" | "navigation" | "window" | "unhandled-rejection" | "performance" | `plugin:${string}` | (string & {});
+interface FarmClientPluginErrorEvent<TState = unknown, TPublic = undefined> extends FarmClientPluginStateEvent<TState, TPublic> {
+    error: unknown;
+    phase: FarmClientPluginErrorPhase;
+    location: FarmClientLocation;
+    navigation?: FarmClientNavigationSession;
+}
+interface FarmClientPerformanceEvent<TState = unknown, TPublic = undefined> extends FarmClientPluginStateEvent<TState, TPublic> {
+    entry: PerformanceEntry;
+    location: FarmClientLocation;
+}
+interface FarmClientPluginCloseEvent<TState = unknown, TPublic = undefined> extends FarmClientPluginStateEvent<TState, TPublic> {
+    reason: "pagehide" | "hmr" | "manual" | (string & {});
+}
+interface FarmClientPlugin<TState = unknown, TPublic = undefined> {
+    setup?(event: FarmClientPluginSetupEvent<TPublic>): MaybePromise<TState>;
+    hydration?: {
+        before?(event: FarmClientHydrationEvent<TState, TPublic>): MaybePromise<void>;
+        after?(event: FarmClientHydrationCompleteEvent<TState, TPublic>): MaybePromise<void>;
+    };
+    navigation?: {
+        before?(event: FarmClientNavigationEvent<TState, TPublic>): MaybePromise<void>;
+        loaded?(event: FarmClientNavigationLoadedEvent<TState, TPublic>): MaybePromise<void>;
+        resolved?(event: FarmClientNavigationResolvedEvent<TState, TPublic>): MaybePromise<void>;
+        rendered?(event: FarmClientNavigationResolvedEvent<TState, TPublic>): MaybePromise<void>;
+        error?(event: FarmClientNavigationErrorEvent<TState, TPublic>): MaybePromise<void>;
+    };
+    error?(event: FarmClientPluginErrorEvent<TState, TPublic>): MaybePromise<void>;
+    performance?(event: FarmClientPerformanceEvent<TState, TPublic>): MaybePromise<void>;
+    close?(event: FarmClientPluginCloseEvent<TState, TPublic>): MaybePromise<void>;
+}
+interface FarmClientPluginRegistration<TPublic = undefined> {
+    name: string;
+    version?: string;
+    enforce?: FarmClientPluginEnforce;
+    definition: FarmClientPlugin<any, TPublic>;
+    public?: TPublic;
+}
+interface FarmClientPluginManagerOptions {
+    router: FarmClientPluginRouter;
+    isDev?: boolean;
+    isProd?: boolean;
+    deploymentId?: string;
+    window?: Window;
+}
+declare class FarmClientPluginManager {
+    private readonly registrations;
+    private readonly options;
+    private readonly instances;
+    private readonly performanceObservers;
+    private startPromise?;
+    private closePromise?;
+    private currentNavigation?;
+    private navigationSequence;
+    private starting;
+    private started;
+    private closed;
+    private readonly reportedErrors;
+    private readonly handleWindowError;
+    private readonly handleUnhandledRejection;
+    private readonly handlePageHide;
+    constructor(registrations: readonly FarmClientPluginRegistration[], options: FarmClientPluginManagerOptions);
+    start(): Promise<void>;
+    beginHydration(input: {
+        container: Element;
+        mode: FarmClientHydrationMode;
+    }): Promise<FarmClientHydrationSession>;
+    completeHydration(session: FarmClientHydrationSession, options?: {
+        recovered?: boolean;
+    }): Promise<void>;
+    failHydration(session: FarmClientHydrationSession, error: unknown): Promise<void>;
+    beginNavigation(input: {
+        from?: string | URL | FarmClientLocation | null;
+        to: string | URL | FarmClientLocation;
+        action: FarmClientNavigationAction;
+        route?: FarmClientNavigationSession["route"];
+    }): Promise<FarmClientNavigationSession>;
+    markNavigationLoaded(session: FarmClientNavigationSession, data?: unknown): Promise<void>;
+    resolveNavigation(session: FarmClientNavigationSession): Promise<void>;
+    scheduleNavigationRendered(session: FarmClientNavigationSession): Promise<void>;
+    failNavigation(session: FarmClientNavigationSession, error: unknown): Promise<void>;
+    reportError(error: unknown, phase: FarmClientPluginErrorPhase, navigation?: FarmClientNavigationSession, location?: FarmClientLocation): Promise<void>;
+    close(reason?: FarmClientPluginCloseEvent["reason"]): Promise<void>;
+    getPlugins(): readonly FarmClientPluginMetadata[];
+    private startInternal;
+    private installBrowserListeners;
+    private installPerformanceObservers;
+    private closeInternal;
+    private runHook;
+    private runErrorHooks;
+    private createSetupEvent;
+    private createStateEvent;
+    private getLocation;
+    private getBaseUrl;
+    private logHookError;
+}
+declare function createClientPluginManager(registrations: readonly FarmClientPluginRegistration[], options: FarmClientPluginManagerOptions): FarmClientPluginManager;
+
+export { FarmClientPluginManager as F, type FarmClientHydrationCompleteEvent as a, type FarmClientHydrationEvent as b, createClientPluginManager as c, type FarmClientHydrationMode as d, type FarmClientHydrationSession as e, type FarmClientLocation as f, type FarmClientNavigationAction as g, type FarmClientNavigationErrorEvent as h, type FarmClientNavigationEvent as i, type FarmClientNavigationLoadedEvent as j, type FarmClientNavigationResolvedEvent as k, type FarmClientNavigationSession as l, type FarmClientPerformanceEvent as m, type FarmClientPlugin as n, type FarmClientPluginCloseEvent as o, type FarmClientPluginEnforce as p, type FarmClientPluginErrorEvent as q, type FarmClientPluginErrorPhase as r, type FarmClientPluginManagerOptions as s, type FarmClientPluginMetadata as t, type FarmClientPluginRegistration as u, type FarmClientPluginRouter as v, type FarmClientPluginSetupEvent as w, type FarmClientPluginStateEvent as x };