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

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

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

  export const createHeadTags: () => Map<
    string,
    SupportedTags | TagFunc
  >;
  export const getHeadTags: () => Map<
    string,
    SupportedTags | TagFunc
  >;
  export const resetHeadTags: () => void;
  export const initializeHeadTags: (
    _html?: string,
  ) => void;

  export type SupportedTags =
    | HTMLTitleElement
    | HTMLMetaElement
    | HTMLScriptElement
    | HTMLLinkElement
    | HTMLStyleElement;

  export type TagProps = PropsWithKnownKeys<SupportedTags>;

  export type HeadTags = SupportedTags[] | TagFunc[];

  export const addMeta: (tag?: Partial<SupportedTags>) => void;
  export const removeMeta = (_tag: string | Partial<SupportedTags>) => null;

  export const Head: () => HeadTags;

  export const Title: (
    props: PropsWithKnownKeys<HTMLTitleElement>,
    content?: string,
  ) => null;

  export const Meta: (
    props: PropsWithKnownKeys<HTMLMetaElement> & { charset?: string & "utf-8" },
  ) => null;

  export const Style: (
    props: PropsWithKnownKeys<HTMLStyleElement>,
    content?: string,
  ) => null;

  export const Link: (props: PropsWithKnownKeys<HTMLLinkElement>) => null;

  export const Script: (
    props: PropsWithKnownKeys<HTMLScriptElement>,
    content?: string,
  ) => null;

  export const parseAttributes: (
    attributeString: string,
  ) => Record<string, string>;

  export const getTagAttribute: (tag: TagProps) => string;

  export const getTagKey: (tag: TagProps) => string;

  export const extractTags: (
    html?: string,
  ) => {
    tag: TagFunc;
    props: PropsWithKnownKeys<SupportedTags>;
    children: TagFunc[];
  }[];
}