vite-plugin-vanjs/server/global.d.ts

An async first mini meta-framework for VanJS powered by Vite

declare module "@vanjs/server" {
  import type { PropsWithKnownKeys } from "vanjs-core";
  import type { SupportedTags } from "@vanjs/meta";
  import type { JSX } from "@vanjs/jsx";
  import type {
    Element as VanElement,
    TagFunc,
  } from "mini-van-plate/van-plate";

  /**
   * A function that takes a list of files and a manifest and returns a string
   * representing the HTML markup for preload links.
   * @param files the list of files
   * @param manifest the vite manifest
   * @returns HTML string
   */
  export const renderPreloadLinks: (
    files: string[],
    manifest: Record<string, string[]>,
  ) => string;

  type ValidVanNode =
    | boolean
    | number
    | string
    | VanElement
    | TagFunc;

  type VanComponent = () =>
    | HTMLElement
    | ValidVanNode
    | ValidVanNode[]
    | SupportedTags
    | SupportedTags[];
  export type Source =
    | JSX.Element
    | VanComponent
    | (() => VanComponent)
    | Promise<ValidVanNode>
    | ValidVanNode
    | undefined;

  /**
   * A function that takes a multitude of source types and returns a string
   * representing the HTML output.
   * @param source the source
   * @returns HTML string
   */
  export const renderToString: (source: Source) => Promise<string>;

  /**
   * A function that generates a <script> for initial hydration data.
   * Serializes the full path-keyed data cache into window.__DATA_CACHE
   * @returns HTML string
   */
  export const getDataPreload: () => string;
}

interface Window {
  __DATA_CACHE?: Record<
    string,
    Record<
      string,
      {
        data: unknown;
        status: string;
        timestamp: number;
        error: { message: string } | null;
      }
    >
  >;
}