@unhead/vue 2.0.0-alpha.8 → 2.0.0-beta.1

package/dist/types.d.cts

@@ -1,137 +0,0 @@
-import { Falsey, BaseHtmlAttr, MaybeArray, BaseBodyAttr, MaybeFunction, ResolvableValues, SchemaAugmentations, TitleTemplate as TitleTemplate$1, EntryAugmentation, Base as Base$1, DefinedValueOrEmptyObject, LinkBase, DataKeys, MaybeEventFnHandlers, HttpEventAttributes, BaseMeta, Style as Style$1, ScriptBase, Noscript as Noscript$1, BodyEvents, MergeHead, HeadEntryOptions, MetaFlatInput, Unhead, SafeMeta, SafeLink, SafeNoscript, SafeScript, SafeHtmlAttr, SafeBodyAttr } from '@unhead/schema';
-export { ActiveHeadEntry, Head, HeadEntryOptions, HeadTag, MergeHead, ResolvedHead, Unhead } from '@unhead/schema';
-import { ComputedRef, Ref, Plugin } from 'vue';
-
-type MaybeComputedRef<T> = T | (() => T) | ComputedRef<T> | Ref<T>;
-type ResolvableArray<T> = MaybeComputedRef<MaybeComputedRef<T>[]>;
-type ResolvableProperties<T> = {
-    [key in keyof T]?: MaybeComputedRef<T[key] | Falsey>;
-};
-
-interface HtmlAttr extends Omit<BaseHtmlAttr, 'class'> {
-    /**
-     * The class global attribute is a space-separated list of the case-sensitive classes of the element.
-     *
-     * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/class
-     */
-    class?: MaybeArray<MaybeComputedRef<string>> | Record<string, MaybeComputedRef<boolean>>;
-}
-interface BodyAttr extends Omit<BaseBodyAttr, 'class' | 'style'> {
-    /**
-     * The class global attribute is a space-separated list of the case-sensitive classes of the element.
-     *
-     * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/class
-     */
-    class?: MaybeArray<MaybeComputedRef<string>> | Record<string, MaybeComputedRef<boolean>>;
-    /**
-     * The class global attribute is a space-separated list of the case-sensitive classes of the element.
-     *
-     * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/class
-     */
-    style?: MaybeArray<MaybeComputedRef<string>> | Record<string, MaybeComputedRef<string | boolean>>;
-}
-type Title = MaybeFunction<number | string | Falsey> | ResolvableValues<({
-    textContent: string;
-} & SchemaAugmentations['title'])>;
-type TitleTemplate = TitleTemplate$1 | Ref<TitleTemplate$1> | ((title?: string) => TitleTemplate$1);
-type Base<E extends EntryAugmentation = Record<string, any>> = ResolvableProperties<Base$1 & SchemaAugmentations['base']> & DefinedValueOrEmptyObject<E>;
-type Link<E extends EntryAugmentation = Record<string, any>> = ResolvableProperties<LinkBase & DataKeys & SchemaAugmentations['link']> & MaybeEventFnHandlers<HttpEventAttributes> & DefinedValueOrEmptyObject<E>;
-type Meta<E extends EntryAugmentation = Record<string, any>> = ResolvableProperties<BaseMeta & DataKeys & SchemaAugmentations['meta']> & DefinedValueOrEmptyObject<E>;
-type Style<E extends EntryAugmentation = Record<string, any>> = ResolvableProperties<Style$1 & DataKeys & SchemaAugmentations['style']> & DefinedValueOrEmptyObject<E>;
-type Script<E extends EntryAugmentation = Record<string, any>> = ResolvableProperties<ScriptBase & DataKeys & SchemaAugmentations['script']> & MaybeEventFnHandlers<HttpEventAttributes> & DefinedValueOrEmptyObject<E>;
-type Noscript<E extends EntryAugmentation = Record<string, any>> = ResolvableProperties<Noscript$1 & DataKeys & SchemaAugmentations['noscript']> & DefinedValueOrEmptyObject<E>;
-type HtmlAttributes<E extends EntryAugmentation = Record<string, any>> = ResolvableProperties<HtmlAttr & DataKeys & SchemaAugmentations['htmlAttrs']> & DefinedValueOrEmptyObject<E>;
-type BodyAttributes<E extends EntryAugmentation = Record<string, any>> = ResolvableProperties<BodyAttr & DataKeys & SchemaAugmentations['bodyAttrs']> & MaybeEventFnHandlers<BodyEvents> & DefinedValueOrEmptyObject<E>;
-interface ReactiveHead<E extends MergeHead = MergeHead> {
-    /**
-     * The `<title>` HTML element defines the document's title that is shown in a browser's title bar or a page's tab.
-     * It only contains text; tags within the element are ignored.
-     *
-     * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/title
-     */
-    title?: Title;
-    /**
-     * Generate the title from a template.
-     */
-    titleTemplate?: TitleTemplate;
-    /**
-     * Variables used to substitute in the title and meta content.
-     */
-    templateParams?: ResolvableArray<{
-        separator?: '|' | '-' | '·' | string;
-    } & Record<string, null | string | ResolvableArray<Record<string, null | string>>>>;
-    /**
-     * The `<base>` HTML element specifies the base URL to use for all relative URLs in a document.
-     * There can be only one <base> element in a document.
-     *
-     * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/base
-     */
-    base?: Base<E['base']>;
-    /**
-     * The `<link>` HTML element specifies relationships between the current document and an external resource.
-     * This element is most commonly used to link to stylesheets, but is also used to establish site icons
-     * (both "favicon" style icons and icons for the home screen and apps on mobile devices) among other things.
-     *
-     * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/link#attr-as
-     */
-    link?: ResolvableArray<Link<E['link']>>;
-    /**
-     * The `<meta>` element represents metadata that cannot be expressed in other HTML elements, like `<link>` or `<script>`.
-     *
-     * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/meta
-     */
-    meta?: ResolvableArray<Meta<E['meta']>>;
-    /**
-     * The `<style>` HTML element contains style information for a document, or part of a document.
-     * It contains CSS, which is applied to the contents of the document containing the `<style>` element.
-     *
-     * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/style
-     */
-    style?: ResolvableArray<(Style<E['style']> | string)>;
-    /**
-     * The `<script>` HTML element is used to embed executable code or data; this is typically used to embed or refer to JavaScript code.
-     *
-     * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/script
-     */
-    script?: ResolvableArray<(Script<E['script']> | string)>;
-    /**
-     * The `<noscript>` HTML element defines a section of HTML to be inserted if a script type on the page is unsupported
-     * or if scripting is currently turned off in the browser.
-     *
-     * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/noscript
-     */
-    noscript?: ResolvableArray<(Noscript<E['noscript']> | string)>;
-    /**
-     * Attributes for the `<html>` HTML element.
-     *
-     * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/html
-     */
-    htmlAttrs?: HtmlAttributes<E['htmlAttrs']>;
-    /**
-     * Attributes for the `<body>` HTML element.
-     *
-     * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/body
-     */
-    bodyAttrs?: BodyAttributes<E['bodyAttrs']>;
-}
-type UseHeadOptions = Omit<HeadEntryOptions, 'head'> & {
-    head?: VueHeadClient<any>;
-};
-type UseHeadInput<T extends MergeHead = Record<string, any>> = MaybeComputedRef<ReactiveHead<T>>;
-type UseSeoMetaInput = ResolvableProperties<MetaFlatInput> & {
-    title?: ReactiveHead['title'];
-    titleTemplate?: ReactiveHead['titleTemplate'];
-};
-type VueHeadClient<T extends MergeHead> = Unhead<MaybeComputedRef<ReactiveHead<T>>> & Plugin;
-
-interface HeadSafe extends Pick<ReactiveHead, 'title' | 'titleTemplate' | 'templateParams'> {
-    meta?: ResolvableArray<SafeMeta>[];
-    link?: ResolvableArray<SafeLink>[];
-    noscript?: ResolvableArray<SafeNoscript>[];
-    script?: ResolvableArray<SafeScript>[];
-    htmlAttrs?: ResolvableArray<SafeHtmlAttr>;
-    bodyAttrs?: ResolvableArray<SafeBodyAttr>;
-}
-type UseHeadSafeInput = MaybeComputedRef<HeadSafe>;
-
-export type { Base, BodyAttr, BodyAttributes, HeadSafe, HtmlAttr, HtmlAttributes, Link, MaybeComputedRef, Meta, Noscript, ReactiveHead, ResolvableArray, ResolvableProperties, Script, Style, Title, TitleTemplate, UseHeadInput, UseHeadOptions, UseHeadSafeInput, UseSeoMetaInput, VueHeadClient };