@unhead/schema 1.11.15 → 2.0.0-alpha.1

package/dist/index.d.cts

@@ -5,8 +5,10 @@ export { BodyEvents, DataKeys, DefinedValueOrEmptyObject, MergeHead, MetaFlatInp
 type Never<T> = {
     [P in keyof T]?: never;
 };
-type FalsyEntries<T> = {
-    [key in keyof T]?: T[key] | null | false | undefined;
+type MaybeFunction<T> = T | (() => T);
+type Falsey = false | null | undefined;
+type ResolvableValues<T> = {
+    [key in keyof T]?: MaybeFunction<T[key] | Falsey>;
 };
 
 type UserTagConfigWithoutInnerContent = TagPriority & TagPosition & ResolvesDuplicates & Never<InnerContent> & {
@@ -55,24 +57,24 @@ interface BaseMeta extends Omit<Meta$1, 'content'> {
     content?: MaybeArray<Stringable> | null;
 }
 type EntryAugmentation = undefined | Record<string, any>;
-type MaybeFunctionEntries<T> = {
+type MaybeEventFnHandlers<T> = {
     [key in keyof T]?: T[key] | ((e: Event) => void);
 };
 type TitleTemplateResolver = string | ((title?: string) => string | null);
-type Title = string | FalsyEntries<({
+type Title = MaybeFunction<number | string | Falsey> | ResolvableValues<({
     textContent: string;
-} & SchemaAugmentations['title']) | null>;
+} & SchemaAugmentations['title'])>;
 type TitleTemplate = TitleTemplateResolver | null | ({
     textContent: TitleTemplateResolver;
 } & SchemaAugmentations['titleTemplate']);
-type Base<E extends EntryAugmentation = Record<string, any>> = Partial<Merge<SchemaAugmentations['base'], FalsyEntries<Base$1>>> & DefinedValueOrEmptyObject<E>;
-type Link<E extends EntryAugmentation = Record<string, any>> = FalsyEntries<LinkBase> & MaybeFunctionEntries<HttpEventAttributes> & DataKeys & SchemaAugmentations['link'] & DefinedValueOrEmptyObject<E>;
-type Meta<E extends EntryAugmentation = Record<string, any>> = FalsyEntries<BaseMeta> & DataKeys & SchemaAugmentations['meta'] & DefinedValueOrEmptyObject<E>;
-type Style<E extends EntryAugmentation = Record<string, any>> = FalsyEntries<Style$1> & DataKeys & SchemaAugmentations['style'] & DefinedValueOrEmptyObject<E>;
-type Script<E extends EntryAugmentation = Record<string, any>> = FalsyEntries<ScriptBase> & MaybeFunctionEntries<HttpEventAttributes> & DataKeys & SchemaAugmentations['script'] & DefinedValueOrEmptyObject<E>;
-type Noscript<E extends EntryAugmentation = Record<string, any>> = FalsyEntries<Noscript$1> & DataKeys & SchemaAugmentations['noscript'] & DefinedValueOrEmptyObject<E>;
-type HtmlAttributes<E extends EntryAugmentation = Record<string, any>> = FalsyEntries<HtmlAttr> & DataKeys & SchemaAugmentations['htmlAttrs'] & DefinedValueOrEmptyObject<E>;
-type BodyAttributes<E extends EntryAugmentation = Record<string, any>> = FalsyEntries<BodyAttr> & MaybeFunctionEntries<BodyEvents> & DataKeys & SchemaAugmentations['bodyAttrs'] & DefinedValueOrEmptyObject<E>;
+type Base<E extends EntryAugmentation = Record<string, any>> = Partial<Merge<SchemaAugmentations['base'], ResolvableValues<Base$1>>> & DefinedValueOrEmptyObject<E>;
+type Link<E extends EntryAugmentation = Record<string, any>> = ResolvableValues<LinkBase> & MaybeEventFnHandlers<HttpEventAttributes> & DataKeys & SchemaAugmentations['link'] & DefinedValueOrEmptyObject<E>;
+type Meta<E extends EntryAugmentation = Record<string, any>> = ResolvableValues<BaseMeta> & DataKeys & SchemaAugmentations['meta'] & DefinedValueOrEmptyObject<E>;
+type Style<E extends EntryAugmentation = Record<string, any>> = ResolvableValues<Style$1> & DataKeys & SchemaAugmentations['style'] & DefinedValueOrEmptyObject<E>;
+type Script<E extends EntryAugmentation = Record<string, any>> = ResolvableValues<ScriptBase> & MaybeEventFnHandlers<HttpEventAttributes> & DataKeys & SchemaAugmentations['script'] & DefinedValueOrEmptyObject<E>;
+type Noscript<E extends EntryAugmentation = Record<string, any>> = ResolvableValues<Noscript$1> & DataKeys & SchemaAugmentations['noscript'] & DefinedValueOrEmptyObject<E>;
+type HtmlAttributes<E extends EntryAugmentation = Record<string, any>> = ResolvableValues<HtmlAttr> & DataKeys & SchemaAugmentations['htmlAttrs'] & DefinedValueOrEmptyObject<E>;
+type BodyAttributes<E extends EntryAugmentation = Record<string, any>> = ResolvableValues<BodyAttr> & MaybeEventFnHandlers<BodyEvents> & DataKeys & SchemaAugmentations['bodyAttrs'] & DefinedValueOrEmptyObject<E>;
 interface HeadUtils {
     /**
      * Generate the title from a template.
@@ -167,14 +169,6 @@ interface ResolvesDuplicates {
      * @default 'replace' (some tags will default to 'merge', such as htmlAttr)
      */
     tagDuplicateStrategy?: 'replace' | 'merge';
-    /**
-     * @deprecated Use `key` instead
-     */
-    hid?: string;
-    /**
-     * @deprecated Use `key` instead
-     */
-    vmid?: string;
 }
 type ValidTagPositions = 'head' | 'bodyClose' | 'bodyOpen';
 interface TagPosition {
@@ -197,12 +191,6 @@ interface InnerContent {
      * Sets the textContent of an element. Safer for XSS.
      */
     textContent?: InnerContentVal;
-    /**
-     * Sets the textContent of an element.
-     *
-     * @deprecated Use `textContent` or `innerHTML`.
-     */
-    children?: InnerContentVal;
 }
 interface TagPriority {
     /**
@@ -218,7 +206,7 @@ interface TagPriority {
      */
     tagPriority?: number | 'critical' | 'high' | 'low' | `before:${string}` | `after:${string}`;
 }
-type TagUserProperties = FalsyEntries<TagPriority & TagPosition & InnerContent & ResolvesDuplicates & ProcessesTemplateParams>;
+type TagUserProperties = ResolvableValues<TagPriority & TagPosition & InnerContent & ResolvesDuplicates & ProcessesTemplateParams>;
 type TagKey = keyof Head;
 type TemplateParams = {
     separator?: '|' | '-' | '·' | string;
@@ -262,7 +250,7 @@ interface HeadTag extends TagPriority, TagPosition, ResolvesDuplicates, HasTempl
     /**
      * @internal
      */
-    _eventHandlers?: Record<string, ((e: Event) => {})>;
+    _eventHandlers?: Record<string, ((e: Event) => Record<string, any> | void)>;
 }
 type HeadTagKeys = (keyof HeadTag)[];
 
@@ -309,7 +297,7 @@ interface HeadHooks {
     'tag:normalise': (ctx: {
         tag: HeadTag;
         entry: HeadEntry<any>;
-        resolvedOptions: CreateHeadOptions;
+        resolvedOptions: CreateClientHeadOptions;
     }) => HookResult;
     'tags:beforeResolve': (ctx: {
         tags: HeadTag[];
@@ -330,14 +318,16 @@ interface HeadHooks {
         tags: HeadTag[];
     }) => HookResult;
     'ssr:rendered': (ctx: SSRRenderContext) => HookResult;
-    'script:updated': (ctx: {
-        script: ScriptInstance<any>;
-    }) => HookResult;
-    'script:instance-fn': (ctx: {
-        script: ScriptInstance<any>;
-        fn: string | symbol;
-        exists: boolean;
-    }) => HookResult;
+}
+
+interface RenderDomHeadOptions {
+    /**
+     * Document to use for rendering. Allows stubbing for testing.
+     */
+    document?: Document;
+}
+interface DomPluginOptions extends RenderDomHeadOptions {
+    delayFn?: (fn: () => void) => void;
 }
 
 /**
@@ -367,7 +357,7 @@ interface HeadEntry<Input> {
      *
      * @internal
      */
-    transform?: (input: Input) => Promise<Input> | Input;
+    transform?: (input: Input) => Input;
     /**
      * Head entry index
      *
@@ -416,17 +406,28 @@ interface ActiveHeadEntry<Input> {
     dispose: () => void;
 }
 interface CreateHeadOptions {
-    domDelayFn?: (fn: () => void) => void;
     document?: Document;
     plugins?: HeadPluginInput[];
     hooks?: NestedHooks<HeadHooks>;
+    /**
+     * Disable the Capo.js tag sorting algorithm.
+     *
+     * This is added to make the v1 -> v2 migration easier allowing users to opt-out of the new sorting algorithm.
+     */
+    disableCapoSorting?: boolean;
+}
+interface CreateClientHeadOptions extends CreateHeadOptions {
+    /**
+     * Options to pass to the DomPlugin.
+     */
+    domOptions?: DomPluginOptions;
 }
 interface HeadEntryOptions extends TagPosition, TagPriority, ProcessesTemplateParams, ResolvesDuplicates {
     mode?: RuntimeMode;
     transform?: (input: unknown) => unknown;
     head?: Unhead;
 }
-interface Unhead<Input extends {} = Head> {
+interface Unhead<Input extends Record<string, any> = Head> {
     /**
      * Registered plugins.
      */
@@ -514,85 +515,4 @@ interface HeadSafe extends Pick<Head, 'title' | 'titleTemplate' | 'templateParam
     bodyAttrs?: SafeBodyAttr;
 }
 
-type UseScriptStatus = 'awaitingLoad' | 'loading' | 'loaded' | 'error' | 'removed';
-/**
- * Either a string source for the script or full script properties.
- */
-type UseScriptInput = string | (Omit<Script, 'src'> & {
-    src: string;
-});
-type UseScriptResolvedInput = Omit<Script, 'src'> & {
-    src: string;
-};
-type BaseScriptApi = Record<symbol | string, any>;
-type AsAsyncFunctionValues<T extends BaseScriptApi> = {
-    [key in keyof T]: T[key] extends any[] ? T[key] : T[key] extends (...args: infer A) => infer R ? (...args: A) => R extends Promise<any> ? R : Promise<R> : T[key] extends Record<any, any> ? AsAsyncFunctionValues<T[key]> : never;
-};
-interface ScriptInstance<T extends BaseScriptApi> {
-    proxy: AsAsyncFunctionValues<T>;
-    instance?: T;
-    id: string;
-    status: UseScriptStatus;
-    entry?: ActiveHeadEntry<any>;
-    load: () => Promise<T>;
-    remove: () => boolean;
-    setupTriggerHandler: (trigger: UseScriptOptions['trigger']) => void;
-    onLoaded: (fn: (instance: T) => void | Promise<void>) => void;
-    onError: (fn: (err?: Error) => void | Promise<void>) => void;
-    /**
-     * @internal
-     */
-    _triggerAbortController?: AbortController | null;
-    /**
-     * @internal
-     */
-    _triggerAbortPromise?: Promise<void>;
-    /**
-     * @internal
-     */
-    _triggerPromises?: Promise<void>[];
-    /**
-     * @internal
-     */
-    _cbs: {
-        loaded: null | ((instance: T) => void | Promise<void>)[];
-        error: null | ((err?: Error) => void | Promise<void>)[];
-    };
-}
-type UseFunctionType<T, U> = T extends {
-    use: infer V;
-} ? V extends (...args: any) => any ? ReturnType<V> : U : U;
-interface UseScriptOptions<T extends BaseScriptApi = {}, U = {}> extends HeadEntryOptions {
-    /**
-     * Resolve the script instance from the window.
-     */
-    use?: () => T | undefined | null;
-    /**
-     * Stub the script instance. Useful for SSR or testing.
-     */
-    stub?: ((ctx: {
-        script: ScriptInstance<T>;
-        fn: string | symbol;
-    }) => any);
-    /**
-     * The trigger to load the script:
-     * - `undefined` | `client` - (Default) Load the script on the client when this js is loaded.
-     * - `manual` - Load the script manually by calling `$script.load()`, exists only on the client.
-     * - `Promise` - Load the script when the promise resolves, exists only on the client.
-     * - `Function` - Register a callback function to load the script, exists only on the client.
-     * - `server` - Have the script injected on the server.
-     */
-    trigger?: 'client' | 'server' | 'manual' | Promise<boolean | void> | ((fn: any) => any) | null;
-    /**
-     * Context to run events with. This is useful in Vue to attach the current instance context before
-     * calling the event, allowing the event to be reactive.
-     */
-    eventContext?: any;
-    /**
-     * Called before the script is initialized. Will not be triggered when the script is already loaded. This means
-     * this is guaranteed to be called only once, unless the script is removed and re-added.
-     */
-    beforeInit?: () => void;
-}
-
-export type { ActiveHeadEntry, AsAsyncFunctionValues, Base, BaseBodyAttr, BaseHtmlAttr, BaseMeta, BodyAttr, BodyAttributes, CreateHeadOptions, DomBeforeRenderCtx, DomRenderTagContext, DomState, EntryAugmentation, EntryResolveCtx, HasTemplateParams, Head, HeadEntry, HeadEntryOptions, HeadHooks, HeadPlugin, HeadPluginInput, HeadPluginOptions, HeadSafe, HeadTag, HeadTagKeys, HeadUtils, HookResult, HtmlAttr, HtmlAttributes, InnerContent, InnerContentVal, Link, MaybeArray, MaybeFunctionEntries, Meta, Noscript, ProcessesTemplateParams, RenderSSRHeadOptions, ResolvesDuplicates, RuntimeMode, SSRHeadPayload, SSRRenderContext, SafeBodyAttr, SafeHtmlAttr, SafeLink, SafeMeta, SafeNoscript, SafeScript, SchemaAugmentations, Script, ScriptInstance, ShouldRenderContext, SideEffectsRecord, Style, TagKey, TagPosition, TagPriority, TagUserProperties, TemplateParams, Title, TitleTemplate, Unhead, UseFunctionType, UseScriptInput, UseScriptOptions, UseScriptResolvedInput, UseScriptStatus, UseSeoMetaInput, UserAttributesConfig, UserTagConfigWithoutInnerContent, ValidTagPositions };
+export type { ActiveHeadEntry, Base, BaseBodyAttr, BaseHtmlAttr, BaseMeta, BodyAttr, BodyAttributes, CreateClientHeadOptions, CreateHeadOptions, DomBeforeRenderCtx, DomPluginOptions, DomRenderTagContext, DomState, EntryAugmentation, EntryResolveCtx, HasTemplateParams, Head, HeadEntry, HeadEntryOptions, HeadHooks, HeadPlugin, HeadPluginInput, HeadPluginOptions, HeadSafe, HeadTag, HeadTagKeys, HeadUtils, HookResult, HtmlAttr, HtmlAttributes, InnerContent, InnerContentVal, Link, MaybeArray, MaybeEventFnHandlers, Meta, Noscript, ProcessesTemplateParams, RenderDomHeadOptions, RenderSSRHeadOptions, ResolvesDuplicates, RuntimeMode, SSRHeadPayload, SSRRenderContext, SafeBodyAttr, SafeHtmlAttr, SafeLink, SafeMeta, SafeNoscript, SafeScript, SchemaAugmentations, Script, ShouldRenderContext, SideEffectsRecord, Style, TagKey, TagPosition, TagPriority, TagUserProperties, TemplateParams, Title, TitleTemplate, Unhead, UseSeoMetaInput, UserAttributesConfig, UserTagConfigWithoutInnerContent, ValidTagPositions };

package/dist/index.d.mts

@@ -5,8 +5,10 @@ export { BodyEvents, DataKeys, DefinedValueOrEmptyObject, MergeHead, MetaFlatInp
 type Never<T> = {
     [P in keyof T]?: never;
 };
-type FalsyEntries<T> = {
-    [key in keyof T]?: T[key] | null | false | undefined;
+type MaybeFunction<T> = T | (() => T);
+type Falsey = false | null | undefined;
+type ResolvableValues<T> = {
+    [key in keyof T]?: MaybeFunction<T[key] | Falsey>;
 };
 
 type UserTagConfigWithoutInnerContent = TagPriority & TagPosition & ResolvesDuplicates & Never<InnerContent> & {
@@ -55,24 +57,24 @@ interface BaseMeta extends Omit<Meta$1, 'content'> {
     content?: MaybeArray<Stringable> | null;
 }
 type EntryAugmentation = undefined | Record<string, any>;
-type MaybeFunctionEntries<T> = {
+type MaybeEventFnHandlers<T> = {
     [key in keyof T]?: T[key] | ((e: Event) => void);
 };
 type TitleTemplateResolver = string | ((title?: string) => string | null);
-type Title = string | FalsyEntries<({
+type Title = MaybeFunction<number | string | Falsey> | ResolvableValues<({
     textContent: string;
-} & SchemaAugmentations['title']) | null>;
+} & SchemaAugmentations['title'])>;
 type TitleTemplate = TitleTemplateResolver | null | ({
     textContent: TitleTemplateResolver;
 } & SchemaAugmentations['titleTemplate']);
-type Base<E extends EntryAugmentation = Record<string, any>> = Partial<Merge<SchemaAugmentations['base'], FalsyEntries<Base$1>>> & DefinedValueOrEmptyObject<E>;
-type Link<E extends EntryAugmentation = Record<string, any>> = FalsyEntries<LinkBase> & MaybeFunctionEntries<HttpEventAttributes> & DataKeys & SchemaAugmentations['link'] & DefinedValueOrEmptyObject<E>;
-type Meta<E extends EntryAugmentation = Record<string, any>> = FalsyEntries<BaseMeta> & DataKeys & SchemaAugmentations['meta'] & DefinedValueOrEmptyObject<E>;
-type Style<E extends EntryAugmentation = Record<string, any>> = FalsyEntries<Style$1> & DataKeys & SchemaAugmentations['style'] & DefinedValueOrEmptyObject<E>;
-type Script<E extends EntryAugmentation = Record<string, any>> = FalsyEntries<ScriptBase> & MaybeFunctionEntries<HttpEventAttributes> & DataKeys & SchemaAugmentations['script'] & DefinedValueOrEmptyObject<E>;
-type Noscript<E extends EntryAugmentation = Record<string, any>> = FalsyEntries<Noscript$1> & DataKeys & SchemaAugmentations['noscript'] & DefinedValueOrEmptyObject<E>;
-type HtmlAttributes<E extends EntryAugmentation = Record<string, any>> = FalsyEntries<HtmlAttr> & DataKeys & SchemaAugmentations['htmlAttrs'] & DefinedValueOrEmptyObject<E>;
-type BodyAttributes<E extends EntryAugmentation = Record<string, any>> = FalsyEntries<BodyAttr> & MaybeFunctionEntries<BodyEvents> & DataKeys & SchemaAugmentations['bodyAttrs'] & DefinedValueOrEmptyObject<E>;
+type Base<E extends EntryAugmentation = Record<string, any>> = Partial<Merge<SchemaAugmentations['base'], ResolvableValues<Base$1>>> & DefinedValueOrEmptyObject<E>;
+type Link<E extends EntryAugmentation = Record<string, any>> = ResolvableValues<LinkBase> & MaybeEventFnHandlers<HttpEventAttributes> & DataKeys & SchemaAugmentations['link'] & DefinedValueOrEmptyObject<E>;
+type Meta<E extends EntryAugmentation = Record<string, any>> = ResolvableValues<BaseMeta> & DataKeys & SchemaAugmentations['meta'] & DefinedValueOrEmptyObject<E>;
+type Style<E extends EntryAugmentation = Record<string, any>> = ResolvableValues<Style$1> & DataKeys & SchemaAugmentations['style'] & DefinedValueOrEmptyObject<E>;
+type Script<E extends EntryAugmentation = Record<string, any>> = ResolvableValues<ScriptBase> & MaybeEventFnHandlers<HttpEventAttributes> & DataKeys & SchemaAugmentations['script'] & DefinedValueOrEmptyObject<E>;
+type Noscript<E extends EntryAugmentation = Record<string, any>> = ResolvableValues<Noscript$1> & DataKeys & SchemaAugmentations['noscript'] & DefinedValueOrEmptyObject<E>;
+type HtmlAttributes<E extends EntryAugmentation = Record<string, any>> = ResolvableValues<HtmlAttr> & DataKeys & SchemaAugmentations['htmlAttrs'] & DefinedValueOrEmptyObject<E>;
+type BodyAttributes<E extends EntryAugmentation = Record<string, any>> = ResolvableValues<BodyAttr> & MaybeEventFnHandlers<BodyEvents> & DataKeys & SchemaAugmentations['bodyAttrs'] & DefinedValueOrEmptyObject<E>;
 interface HeadUtils {
     /**
      * Generate the title from a template.
@@ -167,14 +169,6 @@ interface ResolvesDuplicates {
      * @default 'replace' (some tags will default to 'merge', such as htmlAttr)
      */
     tagDuplicateStrategy?: 'replace' | 'merge';
-    /**
-     * @deprecated Use `key` instead
-     */
-    hid?: string;
-    /**
-     * @deprecated Use `key` instead
-     */
-    vmid?: string;
 }
 type ValidTagPositions = 'head' | 'bodyClose' | 'bodyOpen';
 interface TagPosition {
@@ -197,12 +191,6 @@ interface InnerContent {
      * Sets the textContent of an element. Safer for XSS.
      */
     textContent?: InnerContentVal;
-    /**
-     * Sets the textContent of an element.
-     *
-     * @deprecated Use `textContent` or `innerHTML`.
-     */
-    children?: InnerContentVal;
 }
 interface TagPriority {
     /**
@@ -218,7 +206,7 @@ interface TagPriority {
      */
     tagPriority?: number | 'critical' | 'high' | 'low' | `before:${string}` | `after:${string}`;
 }
-type TagUserProperties = FalsyEntries<TagPriority & TagPosition & InnerContent & ResolvesDuplicates & ProcessesTemplateParams>;
+type TagUserProperties = ResolvableValues<TagPriority & TagPosition & InnerContent & ResolvesDuplicates & ProcessesTemplateParams>;
 type TagKey = keyof Head;
 type TemplateParams = {
     separator?: '|' | '-' | '·' | string;
@@ -262,7 +250,7 @@ interface HeadTag extends TagPriority, TagPosition, ResolvesDuplicates, HasTempl
     /**
      * @internal
      */
-    _eventHandlers?: Record<string, ((e: Event) => {})>;
+    _eventHandlers?: Record<string, ((e: Event) => Record<string, any> | void)>;
 }
 type HeadTagKeys = (keyof HeadTag)[];
 
@@ -309,7 +297,7 @@ interface HeadHooks {
     'tag:normalise': (ctx: {
         tag: HeadTag;
         entry: HeadEntry<any>;
-        resolvedOptions: CreateHeadOptions;
+        resolvedOptions: CreateClientHeadOptions;
     }) => HookResult;
     'tags:beforeResolve': (ctx: {
         tags: HeadTag[];
@@ -330,14 +318,16 @@ interface HeadHooks {
         tags: HeadTag[];
     }) => HookResult;
     'ssr:rendered': (ctx: SSRRenderContext) => HookResult;
-    'script:updated': (ctx: {
-        script: ScriptInstance<any>;
-    }) => HookResult;
-    'script:instance-fn': (ctx: {
-        script: ScriptInstance<any>;
-        fn: string | symbol;
-        exists: boolean;
-    }) => HookResult;
+}
+
+interface RenderDomHeadOptions {
+    /**
+     * Document to use for rendering. Allows stubbing for testing.
+     */
+    document?: Document;
+}
+interface DomPluginOptions extends RenderDomHeadOptions {
+    delayFn?: (fn: () => void) => void;
 }
 
 /**
@@ -367,7 +357,7 @@ interface HeadEntry<Input> {
      *
      * @internal
      */
-    transform?: (input: Input) => Promise<Input> | Input;
+    transform?: (input: Input) => Input;
     /**
      * Head entry index
      *
@@ -416,17 +406,28 @@ interface ActiveHeadEntry<Input> {
     dispose: () => void;
 }
 interface CreateHeadOptions {
-    domDelayFn?: (fn: () => void) => void;
     document?: Document;
     plugins?: HeadPluginInput[];
     hooks?: NestedHooks<HeadHooks>;
+    /**
+     * Disable the Capo.js tag sorting algorithm.
+     *
+     * This is added to make the v1 -> v2 migration easier allowing users to opt-out of the new sorting algorithm.
+     */
+    disableCapoSorting?: boolean;
+}
+interface CreateClientHeadOptions extends CreateHeadOptions {
+    /**
+     * Options to pass to the DomPlugin.
+     */
+    domOptions?: DomPluginOptions;
 }
 interface HeadEntryOptions extends TagPosition, TagPriority, ProcessesTemplateParams, ResolvesDuplicates {
     mode?: RuntimeMode;
     transform?: (input: unknown) => unknown;
     head?: Unhead;
 }
-interface Unhead<Input extends {} = Head> {
+interface Unhead<Input extends Record<string, any> = Head> {
     /**
      * Registered plugins.
      */
@@ -514,85 +515,4 @@ interface HeadSafe extends Pick<Head, 'title' | 'titleTemplate' | 'templateParam
     bodyAttrs?: SafeBodyAttr;
 }
 
-type UseScriptStatus = 'awaitingLoad' | 'loading' | 'loaded' | 'error' | 'removed';
-/**
- * Either a string source for the script or full script properties.
- */
-type UseScriptInput = string | (Omit<Script, 'src'> & {
-    src: string;
-});
-type UseScriptResolvedInput = Omit<Script, 'src'> & {
-    src: string;
-};
-type BaseScriptApi = Record<symbol | string, any>;
-type AsAsyncFunctionValues<T extends BaseScriptApi> = {
-    [key in keyof T]: T[key] extends any[] ? T[key] : T[key] extends (...args: infer A) => infer R ? (...args: A) => R extends Promise<any> ? R : Promise<R> : T[key] extends Record<any, any> ? AsAsyncFunctionValues<T[key]> : never;
-};
-interface ScriptInstance<T extends BaseScriptApi> {
-    proxy: AsAsyncFunctionValues<T>;
-    instance?: T;
-    id: string;
-    status: UseScriptStatus;
-    entry?: ActiveHeadEntry<any>;
-    load: () => Promise<T>;
-    remove: () => boolean;
-    setupTriggerHandler: (trigger: UseScriptOptions['trigger']) => void;
-    onLoaded: (fn: (instance: T) => void | Promise<void>) => void;
-    onError: (fn: (err?: Error) => void | Promise<void>) => void;
-    /**
-     * @internal
-     */
-    _triggerAbortController?: AbortController | null;
-    /**
-     * @internal
-     */
-    _triggerAbortPromise?: Promise<void>;
-    /**
-     * @internal
-     */
-    _triggerPromises?: Promise<void>[];
-    /**
-     * @internal
-     */
-    _cbs: {
-        loaded: null | ((instance: T) => void | Promise<void>)[];
-        error: null | ((err?: Error) => void | Promise<void>)[];
-    };
-}
-type UseFunctionType<T, U> = T extends {
-    use: infer V;
-} ? V extends (...args: any) => any ? ReturnType<V> : U : U;
-interface UseScriptOptions<T extends BaseScriptApi = {}, U = {}> extends HeadEntryOptions {
-    /**
-     * Resolve the script instance from the window.
-     */
-    use?: () => T | undefined | null;
-    /**
-     * Stub the script instance. Useful for SSR or testing.
-     */
-    stub?: ((ctx: {
-        script: ScriptInstance<T>;
-        fn: string | symbol;
-    }) => any);
-    /**
-     * The trigger to load the script:
-     * - `undefined` | `client` - (Default) Load the script on the client when this js is loaded.
-     * - `manual` - Load the script manually by calling `$script.load()`, exists only on the client.
-     * - `Promise` - Load the script when the promise resolves, exists only on the client.
-     * - `Function` - Register a callback function to load the script, exists only on the client.
-     * - `server` - Have the script injected on the server.
-     */
-    trigger?: 'client' | 'server' | 'manual' | Promise<boolean | void> | ((fn: any) => any) | null;
-    /**
-     * Context to run events with. This is useful in Vue to attach the current instance context before
-     * calling the event, allowing the event to be reactive.
-     */
-    eventContext?: any;
-    /**
-     * Called before the script is initialized. Will not be triggered when the script is already loaded. This means
-     * this is guaranteed to be called only once, unless the script is removed and re-added.
-     */
-    beforeInit?: () => void;
-}
-
-export type { ActiveHeadEntry, AsAsyncFunctionValues, Base, BaseBodyAttr, BaseHtmlAttr, BaseMeta, BodyAttr, BodyAttributes, CreateHeadOptions, DomBeforeRenderCtx, DomRenderTagContext, DomState, EntryAugmentation, EntryResolveCtx, HasTemplateParams, Head, HeadEntry, HeadEntryOptions, HeadHooks, HeadPlugin, HeadPluginInput, HeadPluginOptions, HeadSafe, HeadTag, HeadTagKeys, HeadUtils, HookResult, HtmlAttr, HtmlAttributes, InnerContent, InnerContentVal, Link, MaybeArray, MaybeFunctionEntries, Meta, Noscript, ProcessesTemplateParams, RenderSSRHeadOptions, ResolvesDuplicates, RuntimeMode, SSRHeadPayload, SSRRenderContext, SafeBodyAttr, SafeHtmlAttr, SafeLink, SafeMeta, SafeNoscript, SafeScript, SchemaAugmentations, Script, ScriptInstance, ShouldRenderContext, SideEffectsRecord, Style, TagKey, TagPosition, TagPriority, TagUserProperties, TemplateParams, Title, TitleTemplate, Unhead, UseFunctionType, UseScriptInput, UseScriptOptions, UseScriptResolvedInput, UseScriptStatus, UseSeoMetaInput, UserAttributesConfig, UserTagConfigWithoutInnerContent, ValidTagPositions };
+export type { ActiveHeadEntry, Base, BaseBodyAttr, BaseHtmlAttr, BaseMeta, BodyAttr, BodyAttributes, CreateClientHeadOptions, CreateHeadOptions, DomBeforeRenderCtx, DomPluginOptions, DomRenderTagContext, DomState, EntryAugmentation, EntryResolveCtx, HasTemplateParams, Head, HeadEntry, HeadEntryOptions, HeadHooks, HeadPlugin, HeadPluginInput, HeadPluginOptions, HeadSafe, HeadTag, HeadTagKeys, HeadUtils, HookResult, HtmlAttr, HtmlAttributes, InnerContent, InnerContentVal, Link, MaybeArray, MaybeEventFnHandlers, Meta, Noscript, ProcessesTemplateParams, RenderDomHeadOptions, RenderSSRHeadOptions, ResolvesDuplicates, RuntimeMode, SSRHeadPayload, SSRRenderContext, SafeBodyAttr, SafeHtmlAttr, SafeLink, SafeMeta, SafeNoscript, SafeScript, SchemaAugmentations, Script, ShouldRenderContext, SideEffectsRecord, Style, TagKey, TagPosition, TagPriority, TagUserProperties, TemplateParams, Title, TitleTemplate, Unhead, UseSeoMetaInput, UserAttributesConfig, UserTagConfigWithoutInnerContent, ValidTagPositions };

package/dist/index.d.ts

@@ -5,8 +5,10 @@ export { BodyEvents, DataKeys, DefinedValueOrEmptyObject, MergeHead, MetaFlatInp
 type Never<T> = {
     [P in keyof T]?: never;
 };
-type FalsyEntries<T> = {
-    [key in keyof T]?: T[key] | null | false | undefined;
+type MaybeFunction<T> = T | (() => T);
+type Falsey = false | null | undefined;
+type ResolvableValues<T> = {
+    [key in keyof T]?: MaybeFunction<T[key] | Falsey>;
 };
 
 type UserTagConfigWithoutInnerContent = TagPriority & TagPosition & ResolvesDuplicates & Never<InnerContent> & {
@@ -55,24 +57,24 @@ interface BaseMeta extends Omit<Meta$1, 'content'> {
     content?: MaybeArray<Stringable> | null;
 }
 type EntryAugmentation = undefined | Record<string, any>;
-type MaybeFunctionEntries<T> = {
+type MaybeEventFnHandlers<T> = {
     [key in keyof T]?: T[key] | ((e: Event) => void);
 };
 type TitleTemplateResolver = string | ((title?: string) => string | null);
-type Title = string | FalsyEntries<({
+type Title = MaybeFunction<number | string | Falsey> | ResolvableValues<({
     textContent: string;
-} & SchemaAugmentations['title']) | null>;
+} & SchemaAugmentations['title'])>;
 type TitleTemplate = TitleTemplateResolver | null | ({
     textContent: TitleTemplateResolver;
 } & SchemaAugmentations['titleTemplate']);
-type Base<E extends EntryAugmentation = Record<string, any>> = Partial<Merge<SchemaAugmentations['base'], FalsyEntries<Base$1>>> & DefinedValueOrEmptyObject<E>;
-type Link<E extends EntryAugmentation = Record<string, any>> = FalsyEntries<LinkBase> & MaybeFunctionEntries<HttpEventAttributes> & DataKeys & SchemaAugmentations['link'] & DefinedValueOrEmptyObject<E>;
-type Meta<E extends EntryAugmentation = Record<string, any>> = FalsyEntries<BaseMeta> & DataKeys & SchemaAugmentations['meta'] & DefinedValueOrEmptyObject<E>;
-type Style<E extends EntryAugmentation = Record<string, any>> = FalsyEntries<Style$1> & DataKeys & SchemaAugmentations['style'] & DefinedValueOrEmptyObject<E>;
-type Script<E extends EntryAugmentation = Record<string, any>> = FalsyEntries<ScriptBase> & MaybeFunctionEntries<HttpEventAttributes> & DataKeys & SchemaAugmentations['script'] & DefinedValueOrEmptyObject<E>;
-type Noscript<E extends EntryAugmentation = Record<string, any>> = FalsyEntries<Noscript$1> & DataKeys & SchemaAugmentations['noscript'] & DefinedValueOrEmptyObject<E>;
-type HtmlAttributes<E extends EntryAugmentation = Record<string, any>> = FalsyEntries<HtmlAttr> & DataKeys & SchemaAugmentations['htmlAttrs'] & DefinedValueOrEmptyObject<E>;
-type BodyAttributes<E extends EntryAugmentation = Record<string, any>> = FalsyEntries<BodyAttr> & MaybeFunctionEntries<BodyEvents> & DataKeys & SchemaAugmentations['bodyAttrs'] & DefinedValueOrEmptyObject<E>;
+type Base<E extends EntryAugmentation = Record<string, any>> = Partial<Merge<SchemaAugmentations['base'], ResolvableValues<Base$1>>> & DefinedValueOrEmptyObject<E>;
+type Link<E extends EntryAugmentation = Record<string, any>> = ResolvableValues<LinkBase> & MaybeEventFnHandlers<HttpEventAttributes> & DataKeys & SchemaAugmentations['link'] & DefinedValueOrEmptyObject<E>;
+type Meta<E extends EntryAugmentation = Record<string, any>> = ResolvableValues<BaseMeta> & DataKeys & SchemaAugmentations['meta'] & DefinedValueOrEmptyObject<E>;
+type Style<E extends EntryAugmentation = Record<string, any>> = ResolvableValues<Style$1> & DataKeys & SchemaAugmentations['style'] & DefinedValueOrEmptyObject<E>;
+type Script<E extends EntryAugmentation = Record<string, any>> = ResolvableValues<ScriptBase> & MaybeEventFnHandlers<HttpEventAttributes> & DataKeys & SchemaAugmentations['script'] & DefinedValueOrEmptyObject<E>;
+type Noscript<E extends EntryAugmentation = Record<string, any>> = ResolvableValues<Noscript$1> & DataKeys & SchemaAugmentations['noscript'] & DefinedValueOrEmptyObject<E>;
+type HtmlAttributes<E extends EntryAugmentation = Record<string, any>> = ResolvableValues<HtmlAttr> & DataKeys & SchemaAugmentations['htmlAttrs'] & DefinedValueOrEmptyObject<E>;
+type BodyAttributes<E extends EntryAugmentation = Record<string, any>> = ResolvableValues<BodyAttr> & MaybeEventFnHandlers<BodyEvents> & DataKeys & SchemaAugmentations['bodyAttrs'] & DefinedValueOrEmptyObject<E>;
 interface HeadUtils {
     /**
      * Generate the title from a template.
@@ -167,14 +169,6 @@ interface ResolvesDuplicates {
      * @default 'replace' (some tags will default to 'merge', such as htmlAttr)
      */
     tagDuplicateStrategy?: 'replace' | 'merge';
-    /**
-     * @deprecated Use `key` instead
-     */
-    hid?: string;
-    /**
-     * @deprecated Use `key` instead
-     */
-    vmid?: string;
 }
 type ValidTagPositions = 'head' | 'bodyClose' | 'bodyOpen';
 interface TagPosition {
@@ -197,12 +191,6 @@ interface InnerContent {
      * Sets the textContent of an element. Safer for XSS.
      */
     textContent?: InnerContentVal;
-    /**
-     * Sets the textContent of an element.
-     *
-     * @deprecated Use `textContent` or `innerHTML`.
-     */
-    children?: InnerContentVal;
 }
 interface TagPriority {
     /**
@@ -218,7 +206,7 @@ interface TagPriority {
      */
     tagPriority?: number | 'critical' | 'high' | 'low' | `before:${string}` | `after:${string}`;
 }
-type TagUserProperties = FalsyEntries<TagPriority & TagPosition & InnerContent & ResolvesDuplicates & ProcessesTemplateParams>;
+type TagUserProperties = ResolvableValues<TagPriority & TagPosition & InnerContent & ResolvesDuplicates & ProcessesTemplateParams>;
 type TagKey = keyof Head;
 type TemplateParams = {
     separator?: '|' | '-' | '·' | string;
@@ -262,7 +250,7 @@ interface HeadTag extends TagPriority, TagPosition, ResolvesDuplicates, HasTempl
     /**
      * @internal
      */
-    _eventHandlers?: Record<string, ((e: Event) => {})>;
+    _eventHandlers?: Record<string, ((e: Event) => Record<string, any> | void)>;
 }
 type HeadTagKeys = (keyof HeadTag)[];
 
@@ -309,7 +297,7 @@ interface HeadHooks {
     'tag:normalise': (ctx: {
         tag: HeadTag;
         entry: HeadEntry<any>;
-        resolvedOptions: CreateHeadOptions;
+        resolvedOptions: CreateClientHeadOptions;
     }) => HookResult;
     'tags:beforeResolve': (ctx: {
         tags: HeadTag[];
@@ -330,14 +318,16 @@ interface HeadHooks {
         tags: HeadTag[];
     }) => HookResult;
     'ssr:rendered': (ctx: SSRRenderContext) => HookResult;
-    'script:updated': (ctx: {
-        script: ScriptInstance<any>;
-    }) => HookResult;
-    'script:instance-fn': (ctx: {
-        script: ScriptInstance<any>;
-        fn: string | symbol;
-        exists: boolean;
-    }) => HookResult;
+}
+
+interface RenderDomHeadOptions {
+    /**
+     * Document to use for rendering. Allows stubbing for testing.
+     */
+    document?: Document;
+}
+interface DomPluginOptions extends RenderDomHeadOptions {
+    delayFn?: (fn: () => void) => void;
 }
 
 /**
@@ -367,7 +357,7 @@ interface HeadEntry<Input> {
      *
      * @internal
      */
-    transform?: (input: Input) => Promise<Input> | Input;
+    transform?: (input: Input) => Input;
     /**
      * Head entry index
      *
@@ -416,17 +406,28 @@ interface ActiveHeadEntry<Input> {
     dispose: () => void;
 }
 interface CreateHeadOptions {
-    domDelayFn?: (fn: () => void) => void;
     document?: Document;
     plugins?: HeadPluginInput[];
     hooks?: NestedHooks<HeadHooks>;
+    /**
+     * Disable the Capo.js tag sorting algorithm.
+     *
+     * This is added to make the v1 -> v2 migration easier allowing users to opt-out of the new sorting algorithm.
+     */
+    disableCapoSorting?: boolean;
+}
+interface CreateClientHeadOptions extends CreateHeadOptions {
+    /**
+     * Options to pass to the DomPlugin.
+     */
+    domOptions?: DomPluginOptions;
 }
 interface HeadEntryOptions extends TagPosition, TagPriority, ProcessesTemplateParams, ResolvesDuplicates {
     mode?: RuntimeMode;
     transform?: (input: unknown) => unknown;
     head?: Unhead;
 }
-interface Unhead<Input extends {} = Head> {
+interface Unhead<Input extends Record<string, any> = Head> {
     /**
      * Registered plugins.
      */
@@ -514,85 +515,4 @@ interface HeadSafe extends Pick<Head, 'title' | 'titleTemplate' | 'templateParam
     bodyAttrs?: SafeBodyAttr;
 }
 
-type UseScriptStatus = 'awaitingLoad' | 'loading' | 'loaded' | 'error' | 'removed';
-/**
- * Either a string source for the script or full script properties.
- */
-type UseScriptInput = string | (Omit<Script, 'src'> & {
-    src: string;
-});
-type UseScriptResolvedInput = Omit<Script, 'src'> & {
-    src: string;
-};
-type BaseScriptApi = Record<symbol | string, any>;
-type AsAsyncFunctionValues<T extends BaseScriptApi> = {
-    [key in keyof T]: T[key] extends any[] ? T[key] : T[key] extends (...args: infer A) => infer R ? (...args: A) => R extends Promise<any> ? R : Promise<R> : T[key] extends Record<any, any> ? AsAsyncFunctionValues<T[key]> : never;
-};
-interface ScriptInstance<T extends BaseScriptApi> {
-    proxy: AsAsyncFunctionValues<T>;
-    instance?: T;
-    id: string;
-    status: UseScriptStatus;
-    entry?: ActiveHeadEntry<any>;
-    load: () => Promise<T>;
-    remove: () => boolean;
-    setupTriggerHandler: (trigger: UseScriptOptions['trigger']) => void;
-    onLoaded: (fn: (instance: T) => void | Promise<void>) => void;
-    onError: (fn: (err?: Error) => void | Promise<void>) => void;
-    /**
-     * @internal
-     */
-    _triggerAbortController?: AbortController | null;
-    /**
-     * @internal
-     */
-    _triggerAbortPromise?: Promise<void>;
-    /**
-     * @internal
-     */
-    _triggerPromises?: Promise<void>[];
-    /**
-     * @internal
-     */
-    _cbs: {
-        loaded: null | ((instance: T) => void | Promise<void>)[];
-        error: null | ((err?: Error) => void | Promise<void>)[];
-    };
-}
-type UseFunctionType<T, U> = T extends {
-    use: infer V;
-} ? V extends (...args: any) => any ? ReturnType<V> : U : U;
-interface UseScriptOptions<T extends BaseScriptApi = {}, U = {}> extends HeadEntryOptions {
-    /**
-     * Resolve the script instance from the window.
-     */
-    use?: () => T | undefined | null;
-    /**
-     * Stub the script instance. Useful for SSR or testing.
-     */
-    stub?: ((ctx: {
-        script: ScriptInstance<T>;
-        fn: string | symbol;
-    }) => any);
-    /**
-     * The trigger to load the script:
-     * - `undefined` | `client` - (Default) Load the script on the client when this js is loaded.
-     * - `manual` - Load the script manually by calling `$script.load()`, exists only on the client.
-     * - `Promise` - Load the script when the promise resolves, exists only on the client.
-     * - `Function` - Register a callback function to load the script, exists only on the client.
-     * - `server` - Have the script injected on the server.
-     */
-    trigger?: 'client' | 'server' | 'manual' | Promise<boolean | void> | ((fn: any) => any) | null;
-    /**
-     * Context to run events with. This is useful in Vue to attach the current instance context before
-     * calling the event, allowing the event to be reactive.
-     */
-    eventContext?: any;
-    /**
-     * Called before the script is initialized. Will not be triggered when the script is already loaded. This means
-     * this is guaranteed to be called only once, unless the script is removed and re-added.
-     */
-    beforeInit?: () => void;
-}
-
-export type { ActiveHeadEntry, AsAsyncFunctionValues, Base, BaseBodyAttr, BaseHtmlAttr, BaseMeta, BodyAttr, BodyAttributes, CreateHeadOptions, DomBeforeRenderCtx, DomRenderTagContext, DomState, EntryAugmentation, EntryResolveCtx, HasTemplateParams, Head, HeadEntry, HeadEntryOptions, HeadHooks, HeadPlugin, HeadPluginInput, HeadPluginOptions, HeadSafe, HeadTag, HeadTagKeys, HeadUtils, HookResult, HtmlAttr, HtmlAttributes, InnerContent, InnerContentVal, Link, MaybeArray, MaybeFunctionEntries, Meta, Noscript, ProcessesTemplateParams, RenderSSRHeadOptions, ResolvesDuplicates, RuntimeMode, SSRHeadPayload, SSRRenderContext, SafeBodyAttr, SafeHtmlAttr, SafeLink, SafeMeta, SafeNoscript, SafeScript, SchemaAugmentations, Script, ScriptInstance, ShouldRenderContext, SideEffectsRecord, Style, TagKey, TagPosition, TagPriority, TagUserProperties, TemplateParams, Title, TitleTemplate, Unhead, UseFunctionType, UseScriptInput, UseScriptOptions, UseScriptResolvedInput, UseScriptStatus, UseSeoMetaInput, UserAttributesConfig, UserTagConfigWithoutInnerContent, ValidTagPositions };
+export type { ActiveHeadEntry, Base, BaseBodyAttr, BaseHtmlAttr, BaseMeta, BodyAttr, BodyAttributes, CreateClientHeadOptions, CreateHeadOptions, DomBeforeRenderCtx, DomPluginOptions, DomRenderTagContext, DomState, EntryAugmentation, EntryResolveCtx, HasTemplateParams, Head, HeadEntry, HeadEntryOptions, HeadHooks, HeadPlugin, HeadPluginInput, HeadPluginOptions, HeadSafe, HeadTag, HeadTagKeys, HeadUtils, HookResult, HtmlAttr, HtmlAttributes, InnerContent, InnerContentVal, Link, MaybeArray, MaybeEventFnHandlers, Meta, Noscript, ProcessesTemplateParams, RenderDomHeadOptions, RenderSSRHeadOptions, ResolvesDuplicates, RuntimeMode, SSRHeadPayload, SSRRenderContext, SafeBodyAttr, SafeHtmlAttr, SafeLink, SafeMeta, SafeNoscript, SafeScript, SchemaAugmentations, Script, ShouldRenderContext, SideEffectsRecord, Style, TagKey, TagPosition, TagPriority, TagUserProperties, TemplateParams, Title, TitleTemplate, Unhead, UseSeoMetaInput, UserAttributesConfig, UserTagConfigWithoutInnerContent, ValidTagPositions };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@unhead/schema",
   "type": "module",
-  "version": "1.11.15",
+  "version": "2.0.0-alpha.1",
   "author": "Harlan Wilton <harlan@harlanzw.com>",
   "license": "MIT",
   "funding": "https://github.com/sponsors/harlan-zw",