@unhead/schema 0.2.5 → 0.2.6

package/dist/index.d.ts

@@ -220,13 +220,20 @@ interface EntryResolveCtx<T> {
     entries: HeadEntry<T>[];
 }
 interface DomRenderTagContext {
-    head: HeadClient;
+    shouldRender: boolean;
     tag: HeadTag;
-    document: Document;
+}
+interface BeforeRenderContext {
+    shouldRender: boolean;
+    tags: HeadTag[];
+}
+interface SSRRenderContext {
+    tags: HeadTag[];
+    html: SSRHeadPayload;
 }
 interface HeadHooks {
-    'init': (ctx: HeadClient<any>) => HookResult;
-    'entries:updated': (ctx: HeadClient<any>) => HookResult;
+    'init': (ctx: Unhead<any>) => HookResult;
+    'entries:updated': (ctx: Unhead<any>) => HookResult;
     'entries:resolve': (ctx: EntryResolveCtx<any>) => HookResult;
     'tag:normalise': (ctx: {
         tag: HeadTag;
@@ -235,19 +242,10 @@ interface HeadHooks {
     'tags:resolve': (ctx: {
         tags: HeadTag[];
     }) => HookResult;
-    'dom:beforeRender': (ctx: {
-        head: HeadClient;
-        tags: HeadTag[];
-        document: Document;
-    }) => HookResult;
+    'dom:beforeRender': (ctx: BeforeRenderContext) => HookResult;
     'dom:renderTag': (ctx: DomRenderTagContext) => HookResult;
-    'ssr:beforeRender': (ctx: {
-        tags: HeadTag[];
-    }) => HookResult;
-    'ssr:render': (ctx: {
-        tags: HeadTag[];
-        html: SSRHeadPayload;
-    }) => HookResult;
+    'ssr:beforeRender': (ctx: BeforeRenderContext) => HookResult;
+    'ssr:render': (ctx: SSRRenderContext) => HookResult;
 }
 
 /**
@@ -257,11 +255,11 @@ interface HeadHooks {
  */
 declare type SideEffectsRecord = Record<string, () => void>;
 declare type RuntimeMode = 'server' | 'client' | 'all';
-interface HeadEntry<T> {
+interface HeadEntry<Input> {
     /**
      * User provided input for the entry.
      */
-    input: T;
+    input: Input;
     /**
      * The mode that the entry should be used in.
      *
@@ -285,13 +283,13 @@ declare type HeadPlugin = Omit<CreateHeadOptions, 'plugins'>;
 /**
  * An active head entry provides an API to manipulate it.
  */
-interface ActiveHeadEntry<T> {
+interface ActiveHeadEntry<Input> {
     /**
      * Updates the entry with new input.
      *
      * Will first clear any side effects for previous input.
      */
-    patch: (resolvedInput: T) => void;
+    patch: (input: Input) => void;
     /**
      * Dispose the entry, removing it from the active head.
      *
@@ -300,21 +298,23 @@ interface ActiveHeadEntry<T> {
     dispose: () => void;
 }
 interface CreateHeadOptions {
+    domDelayFn?: (fn: () => void) => void;
+    document?: Document;
     plugins?: HeadPlugin[];
     hooks?: NestedHooks<HeadHooks>;
 }
 interface HeadEntryOptions {
     mode?: RuntimeMode;
 }
-interface HeadClient<T extends {} = Head> {
+interface Unhead<Input extends {} = Head> {
     /**
      * The active head entries.
      */
-    headEntries: () => HeadEntry<T>[];
+    headEntries: () => HeadEntry<Input>[];
     /**
      * Create a new head entry.
      */
-    push: (entry: T, options?: HeadEntryOptions) => ActiveHeadEntry<T>;
+    push: (entry: Input, options?: HeadEntryOptions) => ActiveHeadEntry<Input>;
     /**
      * Resolve tags from head entries.
      */
@@ -333,4 +333,4 @@ interface HeadClient<T extends {} = Head> {
     _flushQueuedSideEffects: () => void;
 }
 
-export { ActiveHeadEntry, Base, BaseBodyAttr, BaseHtmlAttr, BodyAttributes, CreateHeadOptions, DomRenderTagContext, EntryAugmentation, EntryResolveCtx, Head, HeadClient, HeadEntry, HeadEntryOptions, HeadHooks, HeadPlugin, HeadTag, HeadTagKeys, HookResult, HtmlAttributes, InnerContent, Link, MaybeArray, Meta, Never, Noscript, ResolvesDuplicates, RuntimeMode, SSRHeadPayload, SchemaAugmentations, Script, SideEffectsRecord, Style, TagInternalProperties, TagPosition, TagPriority, TagUserProperties, Title, TitleTemplate, UserAttributesConfig, UserTagConfigWithoutInnerContent };
+export { ActiveHeadEntry, Base, BaseBodyAttr, BaseHtmlAttr, BeforeRenderContext, BodyAttributes, CreateHeadOptions, DomRenderTagContext, EntryAugmentation, EntryResolveCtx, Head, HeadEntry, HeadEntryOptions, HeadHooks, HeadPlugin, HeadTag, HeadTagKeys, HookResult, HtmlAttributes, InnerContent, Link, MaybeArray, Meta, Never, Noscript, ResolvesDuplicates, RuntimeMode, SSRHeadPayload, SSRRenderContext, SchemaAugmentations, Script, SideEffectsRecord, Style, TagInternalProperties, TagPosition, TagPriority, TagUserProperties, Title, TitleTemplate, Unhead, UserAttributesConfig, UserTagConfigWithoutInnerContent };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@unhead/schema",
   "type": "module",
-  "version": "0.2.5",
+  "version": "0.2.6",
   "packageManager": "pnpm@7.14.0",
   "author": "Harlan Wilton <harlan@harlanzw.com>",
   "license": "MIT",