@unhead/schema 1.3.3 → 1.3.5

package/dist/index.d.ts

@@ -2,6 +2,184 @@ import { MaybePromiseProps, MergeHead, BaseBodyAttributes, HtmlAttributes as Htm
 export { BodyEvents, DataKeys, DefinedValueOrEmptyObject, MergeHead, MetaFlatInput, SpeculationRules } from 'zhead';
 import { NestedHooks, Hookable } from 'hookable';
 
+type HookResult = Promise<void> | void;
+interface SSRHeadPayload {
+    headTags: string;
+    bodyTags: string;
+    bodyTagsOpen: string;
+    htmlAttrs: string;
+    bodyAttrs: string;
+}
+interface EntryResolveCtx<T> {
+    tags: HeadTag[];
+    entries: HeadEntry<T>[];
+}
+interface DomRenderTagContext {
+    id: string;
+    $el: Element;
+    shouldRender: boolean;
+    tag: HeadTag;
+    entry?: HeadEntry<any>;
+    markSideEffect: (key: string, fn: () => void) => void;
+}
+interface DomBeforeRenderCtx extends ShouldRenderContext {
+    tags: DomRenderTagContext[];
+}
+interface ShouldRenderContext {
+    shouldRender: boolean;
+}
+interface SSRRenderContext {
+    tags: HeadTag[];
+    html: SSRHeadPayload;
+}
+interface HeadHooks {
+    'init': (ctx: Unhead<any>) => HookResult;
+    'entries:updated': (ctx: Unhead<any>) => HookResult;
+    'entries:resolve': (ctx: EntryResolveCtx<any>) => HookResult;
+    'tag:normalise': (ctx: {
+        tag: HeadTag;
+        entry: HeadEntry<any>;
+        resolvedOptions: CreateHeadOptions;
+    }) => HookResult;
+    'tags:beforeResolve': (ctx: {
+        tags: HeadTag[];
+    }) => HookResult;
+    'tags:resolve': (ctx: {
+        tags: HeadTag[];
+    }) => 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;
+    'ssr:rendered': (ctx: SSRRenderContext) => HookResult;
+}
+
+/**
+ * Side effects are mapped with a key and their cleanup function.
+ *
+ * For example, `meta:data-h-4h46h465`: () => { document.querySelector('meta[data-h-4h46h465]').remove() }
+ */
+type SideEffectsRecord = Record<string, () => void>;
+type RuntimeMode = 'server' | 'client';
+interface HeadEntry<Input> {
+    /**
+     * User provided input for the entry.
+     */
+    input: Input;
+    /**
+     * Optional resolved input which will be used if set.
+     */
+    resolvedInput?: Input;
+    /**
+     * The mode that the entry should be used in.
+     *
+     * @internal
+     */
+    mode?: RuntimeMode;
+    /**
+     * Transformer function for the entry.
+     *
+     * @internal
+     */
+    transform?: (input: Input) => Promise<Input> | Input;
+    /**
+     * Head entry index
+     *
+     * @internal
+     */
+    _i: number;
+    /**
+     * Default tag position.
+     *
+     * @internal
+     */
+    tagPosition?: TagPosition['tagPosition'];
+    /**
+     * Default tag priority.
+     *
+     * @internal
+     */
+    tagPriority?: TagPriority['tagPriority'];
+}
+type HeadPluginOptions = Omit<CreateHeadOptions, 'plugins'> & {
+    mode?: RuntimeMode;
+};
+type HeadPlugin = HeadPluginOptions | ((head: Unhead) => HeadPluginOptions);
+/**
+ * An active head entry provides an API to manipulate it.
+ */
+interface ActiveHeadEntry<Input> {
+    /**
+     * Updates the entry with new input.
+     *
+     * Will first clear any side effects for previous input.
+     */
+    patch: (input: Input) => void;
+    /**
+     * Dispose the entry, removing it from the active head.
+     *
+     * Will queue side effects for removal.
+     */
+    dispose: () => void;
+}
+interface CreateHeadOptions {
+    domDelayFn?: (fn: () => void) => void;
+    document?: Document;
+    plugins?: HeadPlugin[];
+    hooks?: NestedHooks<HeadHooks>;
+}
+interface HeadEntryOptions extends TagPosition, TagPriority {
+    mode?: RuntimeMode;
+    transform?: (input: unknown) => unknown;
+}
+interface Unhead<Input extends {} = Head> {
+    /**
+     * The active head entries.
+     */
+    headEntries: () => HeadEntry<Input>[];
+    /**
+     * Create a new head entry.
+     */
+    push: (entry: Input, options?: HeadEntryOptions) => ActiveHeadEntry<Input>;
+    /**
+     * Resolve tags from head entries.
+     */
+    resolveTags: () => Promise<HeadTag[]>;
+    /**
+     * Exposed hooks for easier extension.
+     */
+    hooks: Hookable<HeadHooks>;
+    /**
+     * Resolved options
+     */
+    resolvedOptions: CreateHeadOptions;
+    /**
+     * Use a head plugin, loads the plugins hooks.
+     */
+    use: (plugin: HeadPlugin) => void;
+    ssr: boolean;
+    /**
+     * @internal
+     */
+    _dom?: DomState;
+    /**
+     * @internal
+     */
+    _domUpdatePromise?: Promise<void>;
+}
+interface DomState {
+    pendingSideEffects: SideEffectsRecord;
+    sideEffects: SideEffectsRecord;
+    elMap: Record<string, Element>;
+}
+
 interface ResolvesDuplicates {
     /**
      * By default, tags which share the same unique key `name`, `property` are de-duped. To allow duplicates
@@ -77,26 +255,34 @@ interface HasTemplateParams {
     templateParams?: TemplateParams;
 }
 interface HeadTag extends TagPriority, TagPosition, ResolvesDuplicates, HasTemplateParams {
+    tag: TagKey;
+    props: Record<string, string>;
+    innerHTML?: string;
+    textContent?: string;
     /**
      * Entry ID
+     * @internal
      */
     _e?: number;
     /**
      * Position
+     * @internal
      */
     _p?: number;
     /**
      * Dedupe key
+     * @internal
      */
     _d?: string;
     /**
      * Hash code used to represent the tag.
+     * @internal
      */
     _h?: string;
-    tag: TagKey;
-    props: Record<string, string>;
-    innerHTML?: string;
-    textContent?: string;
+    /**
+     * @internal
+     */
+    _m?: RuntimeMode;
 }
 type HeadTagKeys = (keyof HeadTag)[];
 
@@ -264,173 +450,4 @@ interface HeadSafe extends Pick<Head, 'title' | 'titleTemplate' | 'templateParam
     bodyAttrs?: SafeBodyAttr;
 }
 
-type HookResult = Promise<void> | void;
-interface SSRHeadPayload {
-    headTags: string;
-    bodyTags: string;
-    bodyTagsOpen: string;
-    htmlAttrs: string;
-    bodyAttrs: string;
-}
-interface EntryResolveCtx<T> {
-    tags: HeadTag[];
-    entries: HeadEntry<T>[];
-}
-interface DomRenderTagContext {
-    id: string;
-    $el: Element;
-    shouldRender: boolean;
-    tag: HeadTag;
-    entry?: HeadEntry<any>;
-    markSideEffect: (key: string, fn: () => void) => void;
-}
-interface DomBeforeRenderCtx extends ShouldRenderContext {
-    tags: DomRenderTagContext[];
-}
-interface ShouldRenderContext {
-    shouldRender: boolean;
-}
-interface SSRRenderContext {
-    tags: HeadTag[];
-    html: SSRHeadPayload;
-}
-interface HeadHooks {
-    'init': (ctx: Unhead<any>) => HookResult;
-    'entries:updated': (ctx: Unhead<any>) => HookResult;
-    'entries:resolve': (ctx: EntryResolveCtx<any>) => HookResult;
-    'tag:normalise': (ctx: {
-        tag: HeadTag;
-        entry: HeadEntry<any>;
-        resolvedOptions: CreateHeadOptions;
-    }) => HookResult;
-    'tags:beforeResolve': (ctx: {
-        tags: HeadTag[];
-    }) => HookResult;
-    'tags:resolve': (ctx: {
-        tags: HeadTag[];
-    }) => 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;
-    'ssr:rendered': (ctx: SSRRenderContext) => HookResult;
-}
-
-/**
- * Side effects are mapped with a key and their cleanup function.
- *
- * For example, `meta:data-h-4h46h465`: () => { document.querySelector('meta[data-h-4h46h465]').remove() }
- */
-type SideEffectsRecord = Record<string, () => void>;
-type RuntimeMode = 'server' | 'client' | 'all';
-interface HeadEntry<Input> {
-    /**
-     * User provided input for the entry.
-     */
-    input: Input;
-    /**
-     * Optional resolved input which will be used if set.
-     */
-    resolvedInput?: Input;
-    /**
-     * The mode that the entry should be used in.
-     *
-     * @internal
-     */
-    mode?: RuntimeMode;
-    /**
-     * Transformer function for the entry.
-     *
-     * @internal
-     */
-    transform?: (input: Input) => Promise<Input> | Input;
-    /**
-     * Head entry index
-     *
-     * @internal
-     */
-    _i: number;
-    /**
-     * Default tag position.
-     *
-     * @internal
-     */
-    tagPosition?: TagPosition['tagPosition'];
-    /**
-     * Default tag priority.
-     *
-     * @internal
-     */
-    tagPriority?: TagPriority['tagPriority'];
-}
-type HeadPlugin = Omit<CreateHeadOptions, 'plugins'>;
-/**
- * An active head entry provides an API to manipulate it.
- */
-interface ActiveHeadEntry<Input> {
-    /**
-     * Updates the entry with new input.
-     *
-     * Will first clear any side effects for previous input.
-     */
-    patch: (input: Input) => void;
-    /**
-     * Dispose the entry, removing it from the active head.
-     *
-     * Will queue side effects for removal.
-     */
-    dispose: () => void;
-}
-interface CreateHeadOptions {
-    domDelayFn?: (fn: () => void) => void;
-    document?: Document;
-    plugins?: HeadPlugin[];
-    hooks?: NestedHooks<HeadHooks>;
-}
-interface HeadEntryOptions extends TagPosition, TagPriority {
-    mode?: RuntimeMode;
-    transform?: (input: unknown) => unknown;
-}
-interface Unhead<Input extends {} = Head> {
-    /**
-     * The active head entries.
-     */
-    headEntries: () => HeadEntry<Input>[];
-    /**
-     * Create a new head entry.
-     */
-    push: (entry: Input, options?: HeadEntryOptions) => ActiveHeadEntry<Input>;
-    /**
-     * Resolve tags from head entries.
-     */
-    resolveTags: () => Promise<HeadTag[]>;
-    /**
-     * Exposed hooks for easier extension.
-     */
-    hooks: Hookable<HeadHooks>;
-    /**
-     * Resolved options
-     */
-    resolvedOptions: CreateHeadOptions;
-    /**
-     * Use a head plugin, loads the plugins hooks.
-     */
-    use: (plugin: HeadPlugin) => void;
-    ssr: boolean;
-    _dom?: DomState;
-    _domUpdatePromise?: Promise<void>;
-}
-interface DomState {
-    pendingSideEffects: SideEffectsRecord;
-    sideEffects: SideEffectsRecord;
-    elMap: Record<string, Element>;
-}
-
-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 };
+export { ActiveHeadEntry, Base, BaseBodyAttr, BaseHtmlAttr, BaseMeta, BodyAttr, BodyAttributes, CreateHeadOptions, DomBeforeRenderCtx, DomRenderTagContext, DomState, EntryAugmentation, EntryResolveCtx, HasTemplateParams, Head, HeadEntry, HeadEntryOptions, HeadHooks, HeadPlugin, HeadPluginOptions, 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.3.3",
+  "version": "1.3.5",
   "author": "Harlan Wilton <harlan@harlanzw.com>",
   "license": "MIT",
   "funding": "https://github.com/sponsors/harlan-zw",