@unhead/schema 1.2.2 → 1.3.0-beta.1

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { MaybePromiseProps, MergeHead, BaseBodyAttributes, HtmlAttributes as HtmlAttributes$1, Meta as Meta$1, Stringable, Merge, Base as Base$1, DefinedValueOrEmptyObject, LinkBase, HttpEventAttributes, DataKeys, Style as Style$1, ScriptBase, Noscript as Noscript$1, BodyEvents } from 'zhead';
+import { MaybePromiseProps, MergeHead, BaseBodyAttributes, HtmlAttributes as HtmlAttributes$1, Meta as Meta$1, Stringable, Merge, Base as Base$1, DefinedValueOrEmptyObject, LinkBase, HttpEventAttributes, DataKeys, Style as Style$1, ScriptBase, Noscript as Noscript$1, BodyEvents, MetaFlatInput } from 'zhead';
 export { BodyEvents, DataKeys, DefinedValueOrEmptyObject, MergeHead, MetaFlatInput, SpeculationRules } from 'zhead';
 import { NestedHooks, Hookable } from 'hookable';
 
@@ -34,12 +34,6 @@ interface TagPosition {
      * @default 'head'
      */
     tagPosition?: ValidTagPositions;
-    /**
-     * Render the tag before the body close.
-     *
-     * @deprecated Use `tagPosition: 'bodyClose'` instead.
-     */
-    body?: true;
 }
 type InnerContentVal = string | Record<string, any>;
 interface InnerContent {
@@ -245,6 +239,10 @@ interface Head<E extends MergeHead = SchemaAugmentations> extends HeadUtils {
      */
     bodyAttrs?: BodyAttributes<E['bodyAttrs']>;
 }
+type UseSeoMetaInput = MetaFlatInput & {
+    title?: Title;
+    titleTemplate?: TitleTemplate;
+};
 
 type SafeBodyAttr = Pick<BodyAttr, 'id' | 'class'> & DataKeys;
 type SafeHtmlAttr = Pick<HtmlAttr, 'id' | 'class' | 'lang' | 'dir'> & DataKeys;
@@ -279,14 +277,17 @@ interface EntryResolveCtx<T> {
     entries: HeadEntry<T>[];
 }
 interface DomRenderTagContext {
-    renderId: string;
-    $el?: Element | null;
+    id: string;
+    $el: Element;
     shouldRender: boolean;
     tag: HeadTag;
     entry?: HeadEntry<any>;
     markSideEffect: (key: string, fn: () => void) => void;
 }
-interface BeforeRenderContext {
+interface DomBeforeRenderCtx extends ShouldRenderContext {
+    tags: DomRenderTagContext[];
+}
+interface ShouldRenderContext {
     shouldRender: boolean;
 }
 interface SSRRenderContext {
@@ -308,10 +309,14 @@ interface HeadHooks {
     'tags:resolve': (ctx: {
         tags: HeadTag[];
     }) => HookResult;
-    'dom:beforeRender': (ctx: BeforeRenderContext) => HookResult;
-    'dom:beforeRenderTag': (ctx: DomRenderTagContext) => HookResult;
-    'dom:renderTag': (ctx: DomRenderTagContext) => HookResult;
-    'ssr:beforeRender': (ctx: BeforeRenderContext) => HookResult;
+    'dom:beforeRender': (ctx: ShouldRenderContext & {
+        tags: DomRenderTagContext[];
+    }) => HookResult;
+    'dom:renderTag': (ctx: DomRenderTagContext, document: Document, track: any) => HookResult;
+    'dom:rendered': (ctx: {
+        renders: DomRenderTagContext[];
+    }) => HookResult;
+    'ssr:beforeRender': (ctx: ShouldRenderContext) => HookResult;
     'ssr:render': (ctx: {
         tags: HeadTag[];
     }) => HookResult;
@@ -352,12 +357,6 @@ interface HeadEntry<Input> {
      * @internal
      */
     _i: number;
-    /**
-     * Side effects
-     *
-     * @internal
-     */
-    _sde: SideEffectsRecord;
     /**
      * Default tag position.
      *
@@ -395,7 +394,6 @@ interface CreateHeadOptions {
     document?: Document;
     plugins?: HeadPlugin[];
     hooks?: NestedHooks<HeadHooks>;
-    experimentalHashHydration?: boolean;
 }
 interface HeadEntryOptions extends TagPosition, TagPriority {
     mode?: RuntimeMode;
@@ -426,15 +424,14 @@ interface Unhead<Input extends {} = Head> {
      * Use a head plugin, loads the plugins hooks.
      */
     use: (plugin: HeadPlugin) => void;
-    /**
-     * @internal
-     */
-    _popSideEffectQueue: () => SideEffectsRecord;
-    /**
-     * @internal
-     */
-    _elMap: Record<string, Element>;
-    _hash?: string | false;
+    ssr: boolean;
+    _dom?: DomState;
+    _domUpdatePromise?: Promise<void>;
+}
+interface DomState {
+    pendingSideEffects: SideEffectsRecord;
+    sideEffects: SideEffectsRecord;
+    elMap: Record<string, Element>;
 }
 
-export { ActiveHeadEntry, Base, BaseBodyAttr, BaseHtmlAttr, BaseMeta, BeforeRenderContext, BodyAttr, BodyAttributes, CreateHeadOptions, DomRenderTagContext, EntryAugmentation, EntryResolveCtx, HasTemplateParams, Head, HeadEntry, HeadEntryOptions, HeadHooks, HeadPlugin, HeadSafe, HeadTag, HeadTagKeys, HeadUtils, HookResult, HtmlAttr, HtmlAttributes, InnerContent, InnerContentVal, Link, MaybeArray, MaybeFunctionEntries, Meta, Never, Noscript, ResolvesDuplicates, RuntimeMode, SSRHeadPayload, SSRRenderContext, SafeBodyAttr, SafeHtmlAttr, SafeLink, SafeMeta, SafeNoscript, SafeScript, SchemaAugmentations, Script, SideEffectsRecord, Style, TagKey, TagPosition, TagPriority, TagUserProperties, TemplateParams, Title, TitleTemplate, Unhead, UserAttributesConfig, UserTagConfigWithoutInnerContent, ValidTagPositions };
+export { ActiveHeadEntry, Base, BaseBodyAttr, BaseHtmlAttr, BaseMeta, BodyAttr, BodyAttributes, CreateHeadOptions, DomBeforeRenderCtx, DomRenderTagContext, DomState, EntryAugmentation, EntryResolveCtx, HasTemplateParams, Head, HeadEntry, HeadEntryOptions, HeadHooks, HeadPlugin, HeadSafe, HeadTag, HeadTagKeys, HeadUtils, HookResult, HtmlAttr, HtmlAttributes, InnerContent, InnerContentVal, Link, MaybeArray, MaybeFunctionEntries, Meta, Never, Noscript, 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.2.2",
+  "version": "1.3.0-beta.1",
   "author": "Harlan Wilton <harlan@harlanzw.com>",
   "license": "MIT",
   "funding": "https://github.com/sponsors/harlan-zw",