@unhead/schema 1.9.4 → 1.9.6

package/dist/index.d.cts

@@ -73,6 +73,7 @@ interface HeadHooks {
         script: ScriptInstance<any>;
         fn: string | symbol;
         args: any;
+        exists: boolean;
     }) => HookResult;
 }
 
@@ -516,14 +517,13 @@ type UseScriptInput = string | (Omit<Script, 'src'> & {
 type UseScriptResolvedInput = Omit<Script, 'src'> & {
     src: string;
 };
-type ScriptInstance<T> = {
+interface ScriptInstance<T> {
     id: string;
     status: UseScriptStatus;
-    loadPromise: Promise<T>;
     entry?: ActiveHeadEntry<any>;
     load: () => Promise<T>;
     remove: () => boolean;
-} & Promise<T>;
+}
 interface UseScriptOptions<T> extends HeadEntryOptions {
     /**
      * Resolve the script instance from the window.
@@ -533,7 +533,7 @@ interface UseScriptOptions<T> extends HeadEntryOptions {
      * Stub the script instance. Useful for SSR or testing.
      */
     stub?: ((ctx: {
-        script: ScriptInstance<T>;
+        script: Promise<T> & ScriptInstance<T>;
         fn: string | symbol;
     }) => any);
     /**
@@ -550,6 +550,11 @@ interface UseScriptOptions<T> extends HeadEntryOptions {
      * 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, 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, 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, UseScriptInput, UseScriptOptions, UseScriptResolvedInput, UseScriptStatus, UseSeoMetaInput, UserAttributesConfig, UserTagConfigWithoutInnerContent, ValidTagPositions };

package/dist/index.d.mts

@@ -73,6 +73,7 @@ interface HeadHooks {
         script: ScriptInstance<any>;
         fn: string | symbol;
         args: any;
+        exists: boolean;
     }) => HookResult;
 }
 
@@ -516,14 +517,13 @@ type UseScriptInput = string | (Omit<Script, 'src'> & {
 type UseScriptResolvedInput = Omit<Script, 'src'> & {
     src: string;
 };
-type ScriptInstance<T> = {
+interface ScriptInstance<T> {
     id: string;
     status: UseScriptStatus;
-    loadPromise: Promise<T>;
     entry?: ActiveHeadEntry<any>;
     load: () => Promise<T>;
     remove: () => boolean;
-} & Promise<T>;
+}
 interface UseScriptOptions<T> extends HeadEntryOptions {
     /**
      * Resolve the script instance from the window.
@@ -533,7 +533,7 @@ interface UseScriptOptions<T> extends HeadEntryOptions {
      * Stub the script instance. Useful for SSR or testing.
      */
     stub?: ((ctx: {
-        script: ScriptInstance<T>;
+        script: Promise<T> & ScriptInstance<T>;
         fn: string | symbol;
     }) => any);
     /**
@@ -550,6 +550,11 @@ interface UseScriptOptions<T> extends HeadEntryOptions {
      * 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, 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, 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, UseScriptInput, UseScriptOptions, UseScriptResolvedInput, UseScriptStatus, UseSeoMetaInput, UserAttributesConfig, UserTagConfigWithoutInnerContent, ValidTagPositions };

package/dist/index.d.ts

@@ -73,6 +73,7 @@ interface HeadHooks {
         script: ScriptInstance<any>;
         fn: string | symbol;
         args: any;
+        exists: boolean;
     }) => HookResult;
 }
 
@@ -516,14 +517,13 @@ type UseScriptInput = string | (Omit<Script, 'src'> & {
 type UseScriptResolvedInput = Omit<Script, 'src'> & {
     src: string;
 };
-type ScriptInstance<T> = {
+interface ScriptInstance<T> {
     id: string;
     status: UseScriptStatus;
-    loadPromise: Promise<T>;
     entry?: ActiveHeadEntry<any>;
     load: () => Promise<T>;
     remove: () => boolean;
-} & Promise<T>;
+}
 interface UseScriptOptions<T> extends HeadEntryOptions {
     /**
      * Resolve the script instance from the window.
@@ -533,7 +533,7 @@ interface UseScriptOptions<T> extends HeadEntryOptions {
      * Stub the script instance. Useful for SSR or testing.
      */
     stub?: ((ctx: {
-        script: ScriptInstance<T>;
+        script: Promise<T> & ScriptInstance<T>;
         fn: string | symbol;
     }) => any);
     /**
@@ -550,6 +550,11 @@ interface UseScriptOptions<T> extends HeadEntryOptions {
      * 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, 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, 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, UseScriptInput, UseScriptOptions, UseScriptResolvedInput, UseScriptStatus, UseSeoMetaInput, UserAttributesConfig, UserTagConfigWithoutInnerContent, ValidTagPositions };

package/package.json

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