@unhead/schema 1.8.0-beta.0 → 1.8.0-beta.10

package/dist/index.d.cts

@@ -1,5 +1,5 @@
 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';
+export { BodyEvents, DataKeys, DefinedValueOrEmptyObject, MergeHead, MetaFlatInput, ScriptBase, SpeculationRules } from 'zhead';
 import { NestedHooks, Hookable } from 'hookable';
 
 type HookResult = Promise<void> | void;
@@ -10,6 +10,28 @@ interface SSRHeadPayload {
     htmlAttrs: string;
     bodyAttrs: string;
 }
+type UseScriptStatus = 'awaitingLoad' | 'loading' | 'loaded' | 'error' | 'removed';
+interface ScriptInstance<T> {
+    id: string;
+    entry?: ActiveHeadEntry<any>;
+    loaded: boolean;
+    status: UseScriptStatus;
+    load: () => Promise<T>;
+    waitForUse: () => Promise<T>;
+    remove: () => boolean;
+}
+interface UseScriptOptions<T> extends Omit<HeadEntryOptions, 'transform'> {
+    use?: () => T | undefined | null;
+    stub?: ((ctx: {
+        script: ScriptInstance<T>;
+        fn: string | symbol;
+    }) => any);
+    transform?: (script: Script) => Promise<Script> | Script;
+    trigger?: 'idle' | 'manual' | Promise<void>;
+}
+type UseScriptInput = Omit<Script, 'src'> & {
+    src: string;
+};
 interface EntryResolveCtx<T> {
     tags: HeadTag[];
     entries: HeadEntry<T>[];
@@ -60,6 +82,12 @@ interface HeadHooks {
         tags: HeadTag[];
     }) => HookResult;
     'ssr:rendered': (ctx: SSRRenderContext) => HookResult;
+    'script:transform': (ctx: {
+        script: Script;
+    }) => HookResult;
+    'script:updated': (ctx: {
+        script: ScriptInstance<any>;
+    }) => HookResult;
 }
 
 /**
@@ -112,7 +140,14 @@ interface HeadEntry<Input> {
 type HeadPluginOptions = Omit<CreateHeadOptions, 'plugins'> & {
     mode?: RuntimeMode;
 };
-type HeadPlugin = HeadPluginOptions | ((head: Unhead) => HeadPluginOptions);
+type HeadPluginInput = (HeadPluginOptions & {
+    key?: string;
+}) | ((head: Unhead) => HeadPluginOptions & {
+    key?: string;
+});
+type HeadPlugin = HeadPluginOptions & {
+    key?: string;
+};
 /**
  * An active head entry provides an API to manipulate it.
  */
@@ -133,7 +168,7 @@ interface ActiveHeadEntry<Input> {
 interface CreateHeadOptions {
     domDelayFn?: (fn: () => void) => void;
     document?: Document;
-    plugins?: HeadPlugin[];
+    plugins?: HeadPluginInput[];
     hooks?: NestedHooks<HeadHooks>;
 }
 interface HeadEntryOptions extends TagPosition, TagPriority, ProcessesTemplateParams {
@@ -142,6 +177,10 @@ interface HeadEntryOptions extends TagPosition, TagPriority, ProcessesTemplatePa
     head?: Unhead;
 }
 interface Unhead<Input extends {} = Head> {
+    /**
+     * Registered plugins.
+     */
+    plugins: HeadPlugin[];
     /**
      * The active head entries.
      */
@@ -165,7 +204,7 @@ interface Unhead<Input extends {} = Head> {
     /**
      * Use a head plugin, loads the plugins hooks.
      */
-    use: (plugin: HeadPlugin) => void;
+    use: (plugin: HeadPluginInput) => void;
     /**
      * Is it a server-side render context.
      */
@@ -182,6 +221,10 @@ interface Unhead<Input extends {} = Head> {
      * @internal
      */
     dirty: boolean;
+    /**
+     * @internal
+     */
+    _scripts?: Record<string, any>;
 }
 interface DomState {
     pendingSideEffects: SideEffectsRecord;
@@ -258,7 +301,7 @@ interface TagPriority {
 type TagUserProperties = TagPriority & TagPosition & MaybePromiseProps<InnerContent> & ResolvesDuplicates & ProcessesTemplateParams;
 type TagKey = keyof Head;
 type TemplateParams = {
-    separator?: string;
+    separator?: '|' | '-' | '·' | string;
 } & Record<string, null | string | Record<string, string>>;
 interface ProcessesTemplateParams {
     processTemplateParams?: boolean;
@@ -296,6 +339,10 @@ interface HeadTag extends TagPriority, TagPosition, ResolvesDuplicates, HasTempl
      * @internal
      */
     _m?: RuntimeMode;
+    /**
+     * @internal
+     */
+    _eventHandlers?: Record<string, ((e: Event) => {})>;
 }
 type HeadTagKeys = (keyof HeadTag)[];
 
@@ -465,4 +512,4 @@ interface HeadSafe extends Pick<Head, 'title' | 'titleTemplate' | 'templateParam
     bodyAttrs?: SafeBodyAttr;
 }
 
-export type { 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, ProcessesTemplateParams, 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 type { ActiveHeadEntry, 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, Never, Noscript, ProcessesTemplateParams, ResolvesDuplicates, RuntimeMode, SSRHeadPayload, SSRRenderContext, SafeBodyAttr, SafeHtmlAttr, SafeLink, SafeMeta, SafeNoscript, SafeScript, SchemaAugmentations, Script, ScriptInstance, ShouldRenderContext, SideEffectsRecord, Style, TagKey, TagPosition, TagPriority, TagUserProperties, TemplateParams, Title, TitleTemplate, Unhead, UseScriptInput, UseScriptOptions, UseScriptStatus, UseSeoMetaInput, UserAttributesConfig, UserTagConfigWithoutInnerContent, ValidTagPositions };

package/dist/index.d.mts

@@ -1,5 +1,5 @@
 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';
+export { BodyEvents, DataKeys, DefinedValueOrEmptyObject, MergeHead, MetaFlatInput, ScriptBase, SpeculationRules } from 'zhead';
 import { NestedHooks, Hookable } from 'hookable';
 
 type HookResult = Promise<void> | void;
@@ -10,6 +10,28 @@ interface SSRHeadPayload {
     htmlAttrs: string;
     bodyAttrs: string;
 }
+type UseScriptStatus = 'awaitingLoad' | 'loading' | 'loaded' | 'error' | 'removed';
+interface ScriptInstance<T> {
+    id: string;
+    entry?: ActiveHeadEntry<any>;
+    loaded: boolean;
+    status: UseScriptStatus;
+    load: () => Promise<T>;
+    waitForUse: () => Promise<T>;
+    remove: () => boolean;
+}
+interface UseScriptOptions<T> extends Omit<HeadEntryOptions, 'transform'> {
+    use?: () => T | undefined | null;
+    stub?: ((ctx: {
+        script: ScriptInstance<T>;
+        fn: string | symbol;
+    }) => any);
+    transform?: (script: Script) => Promise<Script> | Script;
+    trigger?: 'idle' | 'manual' | Promise<void>;
+}
+type UseScriptInput = Omit<Script, 'src'> & {
+    src: string;
+};
 interface EntryResolveCtx<T> {
     tags: HeadTag[];
     entries: HeadEntry<T>[];
@@ -60,6 +82,12 @@ interface HeadHooks {
         tags: HeadTag[];
     }) => HookResult;
     'ssr:rendered': (ctx: SSRRenderContext) => HookResult;
+    'script:transform': (ctx: {
+        script: Script;
+    }) => HookResult;
+    'script:updated': (ctx: {
+        script: ScriptInstance<any>;
+    }) => HookResult;
 }
 
 /**
@@ -112,7 +140,14 @@ interface HeadEntry<Input> {
 type HeadPluginOptions = Omit<CreateHeadOptions, 'plugins'> & {
     mode?: RuntimeMode;
 };
-type HeadPlugin = HeadPluginOptions | ((head: Unhead) => HeadPluginOptions);
+type HeadPluginInput = (HeadPluginOptions & {
+    key?: string;
+}) | ((head: Unhead) => HeadPluginOptions & {
+    key?: string;
+});
+type HeadPlugin = HeadPluginOptions & {
+    key?: string;
+};
 /**
  * An active head entry provides an API to manipulate it.
  */
@@ -133,7 +168,7 @@ interface ActiveHeadEntry<Input> {
 interface CreateHeadOptions {
     domDelayFn?: (fn: () => void) => void;
     document?: Document;
-    plugins?: HeadPlugin[];
+    plugins?: HeadPluginInput[];
     hooks?: NestedHooks<HeadHooks>;
 }
 interface HeadEntryOptions extends TagPosition, TagPriority, ProcessesTemplateParams {
@@ -142,6 +177,10 @@ interface HeadEntryOptions extends TagPosition, TagPriority, ProcessesTemplatePa
     head?: Unhead;
 }
 interface Unhead<Input extends {} = Head> {
+    /**
+     * Registered plugins.
+     */
+    plugins: HeadPlugin[];
     /**
      * The active head entries.
      */
@@ -165,7 +204,7 @@ interface Unhead<Input extends {} = Head> {
     /**
      * Use a head plugin, loads the plugins hooks.
      */
-    use: (plugin: HeadPlugin) => void;
+    use: (plugin: HeadPluginInput) => void;
     /**
      * Is it a server-side render context.
      */
@@ -182,6 +221,10 @@ interface Unhead<Input extends {} = Head> {
      * @internal
      */
     dirty: boolean;
+    /**
+     * @internal
+     */
+    _scripts?: Record<string, any>;
 }
 interface DomState {
     pendingSideEffects: SideEffectsRecord;
@@ -258,7 +301,7 @@ interface TagPriority {
 type TagUserProperties = TagPriority & TagPosition & MaybePromiseProps<InnerContent> & ResolvesDuplicates & ProcessesTemplateParams;
 type TagKey = keyof Head;
 type TemplateParams = {
-    separator?: string;
+    separator?: '|' | '-' | '·' | string;
 } & Record<string, null | string | Record<string, string>>;
 interface ProcessesTemplateParams {
     processTemplateParams?: boolean;
@@ -296,6 +339,10 @@ interface HeadTag extends TagPriority, TagPosition, ResolvesDuplicates, HasTempl
      * @internal
      */
     _m?: RuntimeMode;
+    /**
+     * @internal
+     */
+    _eventHandlers?: Record<string, ((e: Event) => {})>;
 }
 type HeadTagKeys = (keyof HeadTag)[];
 
@@ -465,4 +512,4 @@ interface HeadSafe extends Pick<Head, 'title' | 'titleTemplate' | 'templateParam
     bodyAttrs?: SafeBodyAttr;
 }
 
-export type { 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, ProcessesTemplateParams, 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 type { ActiveHeadEntry, 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, Never, Noscript, ProcessesTemplateParams, ResolvesDuplicates, RuntimeMode, SSRHeadPayload, SSRRenderContext, SafeBodyAttr, SafeHtmlAttr, SafeLink, SafeMeta, SafeNoscript, SafeScript, SchemaAugmentations, Script, ScriptInstance, ShouldRenderContext, SideEffectsRecord, Style, TagKey, TagPosition, TagPriority, TagUserProperties, TemplateParams, Title, TitleTemplate, Unhead, UseScriptInput, UseScriptOptions, UseScriptStatus, UseSeoMetaInput, UserAttributesConfig, UserTagConfigWithoutInnerContent, ValidTagPositions };

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 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';
+export { BodyEvents, DataKeys, DefinedValueOrEmptyObject, MergeHead, MetaFlatInput, ScriptBase, SpeculationRules } from 'zhead';
 import { NestedHooks, Hookable } from 'hookable';
 
 type HookResult = Promise<void> | void;
@@ -10,6 +10,28 @@ interface SSRHeadPayload {
     htmlAttrs: string;
     bodyAttrs: string;
 }
+type UseScriptStatus = 'awaitingLoad' | 'loading' | 'loaded' | 'error' | 'removed';
+interface ScriptInstance<T> {
+    id: string;
+    entry?: ActiveHeadEntry<any>;
+    loaded: boolean;
+    status: UseScriptStatus;
+    load: () => Promise<T>;
+    waitForUse: () => Promise<T>;
+    remove: () => boolean;
+}
+interface UseScriptOptions<T> extends Omit<HeadEntryOptions, 'transform'> {
+    use?: () => T | undefined | null;
+    stub?: ((ctx: {
+        script: ScriptInstance<T>;
+        fn: string | symbol;
+    }) => any);
+    transform?: (script: Script) => Promise<Script> | Script;
+    trigger?: 'idle' | 'manual' | Promise<void>;
+}
+type UseScriptInput = Omit<Script, 'src'> & {
+    src: string;
+};
 interface EntryResolveCtx<T> {
     tags: HeadTag[];
     entries: HeadEntry<T>[];
@@ -60,6 +82,12 @@ interface HeadHooks {
         tags: HeadTag[];
     }) => HookResult;
     'ssr:rendered': (ctx: SSRRenderContext) => HookResult;
+    'script:transform': (ctx: {
+        script: Script;
+    }) => HookResult;
+    'script:updated': (ctx: {
+        script: ScriptInstance<any>;
+    }) => HookResult;
 }
 
 /**
@@ -112,7 +140,14 @@ interface HeadEntry<Input> {
 type HeadPluginOptions = Omit<CreateHeadOptions, 'plugins'> & {
     mode?: RuntimeMode;
 };
-type HeadPlugin = HeadPluginOptions | ((head: Unhead) => HeadPluginOptions);
+type HeadPluginInput = (HeadPluginOptions & {
+    key?: string;
+}) | ((head: Unhead) => HeadPluginOptions & {
+    key?: string;
+});
+type HeadPlugin = HeadPluginOptions & {
+    key?: string;
+};
 /**
  * An active head entry provides an API to manipulate it.
  */
@@ -133,7 +168,7 @@ interface ActiveHeadEntry<Input> {
 interface CreateHeadOptions {
     domDelayFn?: (fn: () => void) => void;
     document?: Document;
-    plugins?: HeadPlugin[];
+    plugins?: HeadPluginInput[];
     hooks?: NestedHooks<HeadHooks>;
 }
 interface HeadEntryOptions extends TagPosition, TagPriority, ProcessesTemplateParams {
@@ -142,6 +177,10 @@ interface HeadEntryOptions extends TagPosition, TagPriority, ProcessesTemplatePa
     head?: Unhead;
 }
 interface Unhead<Input extends {} = Head> {
+    /**
+     * Registered plugins.
+     */
+    plugins: HeadPlugin[];
     /**
      * The active head entries.
      */
@@ -165,7 +204,7 @@ interface Unhead<Input extends {} = Head> {
     /**
      * Use a head plugin, loads the plugins hooks.
      */
-    use: (plugin: HeadPlugin) => void;
+    use: (plugin: HeadPluginInput) => void;
     /**
      * Is it a server-side render context.
      */
@@ -182,6 +221,10 @@ interface Unhead<Input extends {} = Head> {
      * @internal
      */
     dirty: boolean;
+    /**
+     * @internal
+     */
+    _scripts?: Record<string, any>;
 }
 interface DomState {
     pendingSideEffects: SideEffectsRecord;
@@ -258,7 +301,7 @@ interface TagPriority {
 type TagUserProperties = TagPriority & TagPosition & MaybePromiseProps<InnerContent> & ResolvesDuplicates & ProcessesTemplateParams;
 type TagKey = keyof Head;
 type TemplateParams = {
-    separator?: string;
+    separator?: '|' | '-' | '·' | string;
 } & Record<string, null | string | Record<string, string>>;
 interface ProcessesTemplateParams {
     processTemplateParams?: boolean;
@@ -296,6 +339,10 @@ interface HeadTag extends TagPriority, TagPosition, ResolvesDuplicates, HasTempl
      * @internal
      */
     _m?: RuntimeMode;
+    /**
+     * @internal
+     */
+    _eventHandlers?: Record<string, ((e: Event) => {})>;
 }
 type HeadTagKeys = (keyof HeadTag)[];
 
@@ -465,4 +512,4 @@ interface HeadSafe extends Pick<Head, 'title' | 'titleTemplate' | 'templateParam
     bodyAttrs?: SafeBodyAttr;
 }
 
-export type { 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, ProcessesTemplateParams, 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 type { ActiveHeadEntry, 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, Never, Noscript, ProcessesTemplateParams, ResolvesDuplicates, RuntimeMode, SSRHeadPayload, SSRRenderContext, SafeBodyAttr, SafeHtmlAttr, SafeLink, SafeMeta, SafeNoscript, SafeScript, SchemaAugmentations, Script, ScriptInstance, ShouldRenderContext, SideEffectsRecord, Style, TagKey, TagPosition, TagPriority, TagUserProperties, TemplateParams, Title, TitleTemplate, Unhead, UseScriptInput, UseScriptOptions, UseScriptStatus, UseSeoMetaInput, UserAttributesConfig, UserTagConfigWithoutInnerContent, ValidTagPositions };

package/package.json

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