@unhead/schema 1.0.22 → 1.1.0

package/dist/index.d.ts

@@ -1,5 +1,5 @@
-import { MaybePromiseProps, HeadTag as HeadTag$1, MergeHead, BaseBodyAttributes, HtmlAttributes as HtmlAttributes$1, Merge, Base as Base$1, DefinedValueOrEmptyObject, LinkBase, HttpEventAttributes, DataKeys, Style as Style$1, ScriptBase, Noscript as Noscript$1, BodyEvents, Meta as Meta$1, Stringable } from 'zhead';
-export { BodyEvents, DataKeys, DefinedValueOrEmptyObject, MergeHead, MetaFlatInput, SpeculationRules, TagKey } 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 } from 'zhead';
+export { BodyEvents, DataKeys, DefinedValueOrEmptyObject, MergeHead, MetaFlatInput, SpeculationRules } from 'zhead';
 import { NestedHooks, Hookable } from 'hookable';
 
 interface ResolvesDuplicates {
@@ -43,19 +43,19 @@ interface InnerContent {
     /**
      * Text content of the tag.
      *
-     * Alias for children
+     * Warning: This is not safe for XSS. Do not use this with user input, use `textContent` instead.
      */
     innerHTML?: InnerContentVal;
     /**
-     * Sets the textContent of an element.
+     * Sets the textContent of an element. Safer for XSS.
      */
-    children?: InnerContentVal;
+    textContent?: InnerContentVal;
     /**
-     * Sets the textContent of an element. This will be HTML encoded.
+     * Sets the textContent of an element.
      *
-     * Alias for children
+     * @deprecated Use `textContent` or `innerHTML`.
      */
-    textContent?: InnerContentVal;
+    children?: InnerContentVal;
 }
 interface TagPriority {
     /**
@@ -72,7 +72,14 @@ interface TagPriority {
     tagPriority?: number | 'critical' | 'high' | 'low' | `before:${string}` | `after:${string}`;
 }
 type TagUserProperties = TagPriority & TagPosition & MaybePromiseProps<InnerContent> & ResolvesDuplicates;
-interface TagInternalProperties {
+type TagKey = keyof Head;
+type TemplateParams = {
+    separator?: string;
+} & Record<string, string | Record<string, string>>;
+interface HasTemplateParams {
+    templateParams?: TemplateParams;
+}
+interface HeadTag extends TagPriority, TagPosition, ResolvesDuplicates, HasTemplateParams {
     /**
      * Entry ID
      */
@@ -85,8 +92,15 @@ interface TagInternalProperties {
      * Dedupe key
      */
     _d?: string;
+    /**
+     * Hash code used to represent the tag.
+     */
+    _h?: string;
+    tag: TagKey;
+    props: Record<string, string>;
+    innerHTML?: string;
+    textContent?: string;
 }
-type HeadTag = HeadTag$1 & TagUserProperties & TagInternalProperties;
 type HeadTagKeys = (keyof HeadTag)[];
 
 type Never<T> = {
@@ -147,7 +161,19 @@ type Script<E extends EntryAugmentation = {}> = MaybePromiseProps<ScriptBase> &
 type Noscript<E extends EntryAugmentation = {}> = MaybePromiseProps<Noscript$1> & DataKeys & SchemaAugmentations['noscript'] & DefinedValueOrEmptyObject<E>;
 type HtmlAttributes<E extends EntryAugmentation = {}> = MaybePromiseProps<HtmlAttr> & DataKeys & SchemaAugmentations['htmlAttrs'] & DefinedValueOrEmptyObject<E>;
 type BodyAttributes<E extends EntryAugmentation = {}> = MaybePromiseProps<BodyAttr> & MaybeFunctionEntries<BodyEvents> & DataKeys & SchemaAugmentations['bodyAttrs'] & DefinedValueOrEmptyObject<E>;
-interface Head<E extends MergeHead = SchemaAugmentations> {
+interface HeadUtils {
+    /**
+     * Generate the title from a template.
+     *
+     * Should include a `%s` placeholder for the title, for example `%s - My Site`.
+     */
+    titleTemplate?: TitleTemplate;
+    /**
+     * Variables used to substitute in the title and meta content.
+     */
+    templateParams?: TemplateParams;
+}
+interface Head<E extends MergeHead = SchemaAugmentations> extends HeadUtils {
     /**
      * The <title> HTML element defines the document's title that is shown in a browser's title bar or a page's tab.
      * It only contains text; tags within the element are ignored.
@@ -155,12 +181,6 @@ interface Head<E extends MergeHead = SchemaAugmentations> {
      * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/title
      */
     title?: Title | Promise<Title>;
-    /**
-     * Generate the title from a template.
-     *
-     * Should include a `%s` placeholder for the title, for example `%s - My Site`.
-     */
-    titleTemplate?: TitleTemplate;
     /**
      * The <base> HTML element specifies the base URL to use for all relative URLs in a document.
      * There can be only one <base> element in a document.
@@ -188,20 +208,20 @@ interface Head<E extends MergeHead = SchemaAugmentations> {
      *
      * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/style
      */
-    style?: Style<E['style']>[];
+    style?: (Style<E['style']> | string)[];
     /**
      * The <script> HTML element is used to embed executable code or data; this is typically used to embed or refer to JavaScript code.
      *
      * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/script
      */
-    script?: Script<E['script']>[];
+    script?: (Script<E['script']> | string)[];
     /**
      * The <noscript> HTML element defines a section of HTML to be inserted if a script type on the page is unsupported
      * or if scripting is currently turned off in the browser.
      *
      * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/noscript
      */
-    noscript?: Noscript<E['noscript']>[];
+    noscript?: (Noscript<E['noscript']> | string)[];
     /**
      * Attributes for the <html> HTML element.
      *
@@ -216,6 +236,26 @@ interface Head<E extends MergeHead = SchemaAugmentations> {
     bodyAttrs?: BodyAttributes<E['bodyAttrs']>;
 }
 
+type SafeBodyAttr = Pick<BodyAttr, 'id' | 'class'> & DataKeys;
+type SafeHtmlAttr = Pick<HtmlAttr, 'id' | 'class' | 'lang' | 'dir'> & DataKeys;
+type SafeMeta = Pick<Meta, 'id' | 'name' | 'property' | 'content'> & DataKeys;
+type SafeLink = Pick<Link, 'color' | 'crossorigin' | 'fetchpriority' | 'href' | 'hreflang' | 'imagesizes' | 'imagesrcset' | 'integrity' | 'media' | 'referrerpolicy' | 'sizes' | 'id'> & {
+    rel?: Omit<Link['rel'], 'stylesheet' | 'canonical' | 'modulepreload' | 'prerender' | 'preload' | 'prefetch'>;
+    type?: 'audio/aac' | 'application/x-abiword' | 'application/x-freearc' | 'image/avif' | 'video/x-msvideo' | 'application/vnd.amazon.ebook' | 'application/octet-stream' | 'image/bmp' | 'application/x-bzip' | 'application/x-bzip2' | 'application/x-cdf' | 'application/x-csh' | 'text/csv' | 'application/msword' | 'application/vnd.openxmlformats-officedocument.wordprocessingml.document' | 'application/vnd.ms-fontobject' | 'application/epub+zip' | 'application/gzip' | 'image/gif' | 'image/vnd.microsoft.icon' | 'text/calendar' | 'application/java-archive' | 'image/jpeg' | 'application/json' | 'application/ld+json' | 'audio/midi' | 'audio/x-midi' | 'audio/mpeg' | 'video/mp4' | 'video/mpeg' | 'application/vnd.apple.installer+xml' | 'application/vnd.oasis.opendocument.presentation' | 'application/vnd.oasis.opendocument.spreadsheet' | 'application/vnd.oasis.opendocument.text' | 'audio/ogg' | 'video/ogg' | 'application/ogg' | 'audio/opus' | 'font/otf' | 'image/png' | 'application/pdf' | 'application/x-httpd-php' | 'application/vnd.ms-powerpoint' | 'application/vnd.openxmlformats-officedocument.presentationml.presentation' | 'application/vnd.rar' | 'application/rtf' | 'application/x-sh' | 'image/svg+xml' | 'application/x-tar' | 'image/tiff' | 'video/mp2t' | 'font/ttf' | 'text/plain' | 'application/vnd.visio' | 'audio/wav' | 'audio/webm' | 'video/webm' | 'image/webp' | 'font/woff' | 'font/woff2' | 'application/xhtml+xml' | 'application/vnd.ms-excel' | 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet' | 'text/xml' | 'application/atom+xml' | 'application/xml' | 'application/vnd.mozilla.xul+xml' | 'application/zip' | 'video/3gpp' | 'audio/3gpp' | 'video/3gpp2' | 'audio/3gpp2' | (string & Record<never, never>);
+} & DataKeys;
+type SafeScript = Pick<Script, 'id' | 'textContent'> & {
+    type: 'application/json' | 'application/ld+json';
+} & DataKeys;
+type SafeNoscript = Pick<Noscript, 'id' | 'textContent'> & DataKeys;
+interface HeadSafe extends Pick<Head, 'title' | 'titleTemplate' | 'templateParams'> {
+    meta?: SafeMeta[];
+    link?: SafeLink[];
+    noscript?: SafeNoscript[];
+    script?: SafeScript[];
+    htmlAttrs?: SafeHtmlAttr;
+    bodyAttrs?: SafeBodyAttr;
+}
+
 type HookResult = Promise<void> | void;
 interface SSRHeadPayload {
     headTags: string;
@@ -229,12 +269,12 @@ interface EntryResolveCtx<T> {
     entries: HeadEntry<T>[];
 }
 interface DomRenderTagContext {
+    renderId: string;
     $el?: Element | null;
     shouldRender: boolean;
-    renderId: string;
     tag: HeadTag;
     entry?: HeadEntry<any>;
-    staleSideEffects: SideEffectsRecord;
+    markSideEffect: (key: string, fn: () => void) => void;
 }
 interface BeforeRenderContext {
     shouldRender: boolean;
@@ -250,6 +290,7 @@ interface HeadHooks {
     'tag:normalise': (ctx: {
         tag: HeadTag;
         entry: HeadEntry<any>;
+        resolvedOptions: CreateHeadOptions;
     }) => HookResult;
     'tags:resolve': (ctx: {
         tags: HeadTag[];
@@ -267,7 +308,7 @@ interface HeadHooks {
 /**
  * Side effects are mapped with a key and their cleanup function.
  *
- * For example `meta:data-h-4h46h465`: () => { document.querySelector('meta[data-h-4h46h465]').remove() }
+ * For example, `meta:data-h-4h46h465`: () => { document.querySelector('meta[data-h-4h46h465]').remove() }
  */
 type SideEffectsRecord = Record<string, () => void>;
 type RuntimeMode = 'server' | 'client' | 'all';
@@ -286,6 +327,12 @@ interface HeadEntry<Input> {
      * @internal
      */
     _m?: RuntimeMode;
+    /**
+     * Transformer function for the entry.
+     *
+     * @internal
+     */
+    _t?: (input: Input) => Input;
     /**
      * Head entry index
      *
@@ -322,9 +369,11 @@ interface CreateHeadOptions {
     document?: Document;
     plugins?: HeadPlugin[];
     hooks?: NestedHooks<HeadHooks>;
+    experimentalHashHydration?: boolean;
 }
 interface HeadEntryOptions {
     mode?: RuntimeMode;
+    transform?: (input: unknown) => unknown;
 }
 interface Unhead<Input extends {} = Head> {
     /**
@@ -359,6 +408,7 @@ interface Unhead<Input extends {} = Head> {
      * @internal
      */
     _elMap: Record<string, Element>;
+    _hash?: string | false;
 }
 
-export { ActiveHeadEntry, Base, BaseBodyAttr, BaseHtmlAttr, BeforeRenderContext, BodyAttributes, CreateHeadOptions, DomRenderTagContext, EntryAugmentation, EntryResolveCtx, Head, HeadEntry, HeadEntryOptions, HeadHooks, HeadPlugin, HeadTag, HeadTagKeys, HookResult, HtmlAttributes, InnerContent, InnerContentVal, Link, MaybeArray, MaybeFunctionEntries, Meta, Never, Noscript, ResolvesDuplicates, RuntimeMode, SSRHeadPayload, SSRRenderContext, SchemaAugmentations, Script, SideEffectsRecord, Style, TagInternalProperties, TagPosition, TagPriority, TagUserProperties, Title, TitleTemplate, Unhead, UserAttributesConfig, UserTagConfigWithoutInnerContent, ValidTagPositions };
+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 };

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@unhead/schema",
   "type": "module",
-  "version": "1.0.22",
-  "packageManager": "pnpm@7.26.3",
+  "version": "1.1.0",
+  "packageManager": "pnpm@7.27.1",
   "author": "Harlan Wilton <harlan@harlanzw.com>",
   "license": "MIT",
   "funding": "https://github.com/sponsors/harlan-zw",
@@ -36,7 +36,7 @@
   ],
   "dependencies": {
     "hookable": "^5.4.2",
-    "zhead": "^2.0.0"
+    "zhead": "^2.0.4"
   },
   "scripts": {
     "build": "unbuild .",