@unhead/schema 0.0.6 → 0.1.0

package/dist/index.d.ts

@@ -1,5 +1,6 @@
 import { HeadTag as HeadTag$1, MergeHead, BodyAttributes as BodyAttributes$1, HtmlAttributes as HtmlAttributes$1, Merge, Base as Base$1, DefinedValueOrEmptyObject, Link as Link$1, DataKeys, Style as Style$1, Script as Script$1, Noscript as Noscript$1, Meta as Meta$1, Stringable } from '@zhead/schema';
 export { DataKeys, DefinedValueOrEmptyObject, MergeHead, TagKey } from '@zhead/schema';
+import { NestedHooks, Hookable } from 'hookable';
 
 interface ResolvesDuplicates {
     /**
@@ -201,4 +202,102 @@ interface Head<E extends MergeHead = SchemaAugmentations> {
     bodyAttrs?: BodyAttributes<E['bodyAttrs']>;
 }
 
-export { Base, BaseBodyAttr, BaseHtmlAttr, BodyAttributes, EntryAugmentation, Head, HeadTag, HeadTagKeys, HtmlAttributes, InnerContent, Link, MaybeArray, Meta, Never, Noscript, ResolvesDuplicates, SchemaAugmentations, Script, Style, TagInternalProperties, TagPosition, TagPriority, TagUserProperties, Title, TitleTemplate, UserAttributesConfig, UserTagConfigWithoutInnerContent };
+declare type HookResult = Promise<void> | void;
+interface EntryResolveCtx<T> {
+    tags: HeadTag[];
+    entries: HeadEntry<T>[];
+}
+interface HeadHooks {
+    'entries:resolve': (ctx: EntryResolveCtx<any>) => HookResult;
+    'tag:normalise': (ctx: {
+        tag: HeadTag;
+        entry: HeadEntry<any>;
+    }) => HookResult;
+    'tags:resolve': (ctx: {
+        tags: HeadTag[];
+    }) => 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() }
+ */
+declare type SideEffectsRecord = Record<string, () => void>;
+declare type RuntimeMode = 'server' | 'client' | 'all';
+interface HeadEntry<T> {
+    /**
+     * User provided input for the entry.
+     */
+    input: T;
+    /**
+     * The mode that the entry should be used in.
+     *
+     * @internal
+     */
+    _m?: RuntimeMode;
+    /**
+     * Head entry index
+     *
+     * @internal
+     */
+    _i: number;
+    /**
+     * Side effects
+     *
+     * @internal
+     */
+    _sde: SideEffectsRecord;
+}
+declare type HeadPlugin = Omit<CreateHeadOptions, 'plugins'>;
+/**
+ * An active head entry provides an API to manipulate it.
+ */
+interface ActiveHeadEntry<T> {
+    /**
+     * Updates the entry with new input.
+     *
+     * Will first clear any side effects for previous input.
+     */
+    patch: (resolvedInput: T) => void;
+    /**
+     * Dispose the entry, removing it from the active head.
+     *
+     * Will queue side effects for removal.
+     */
+    dispose: () => void;
+}
+interface CreateHeadOptions {
+    plugins?: HeadPlugin[];
+    hooks?: NestedHooks<HeadHooks>;
+}
+interface HeadEntryOptions {
+    mode?: RuntimeMode;
+}
+interface HeadClient<T extends {} = Head> {
+    /**
+     * The active head entries.
+     */
+    headEntries: () => HeadEntry<T>[];
+    /**
+     * Create a new head entry.
+     */
+    push: (entry: T, options?: HeadEntryOptions) => ActiveHeadEntry<T>;
+    /**
+     * Resolve tags from head entries.
+     */
+    resolveTags: () => Promise<HeadTag[]>;
+    /**
+     * Exposed hooks for easier extension.
+     */
+    hooks: Hookable<HeadHooks>;
+    /**
+     * @internal
+     */
+    _removeQueuedSideEffect: (key: string) => void;
+    /**
+     * @internal
+     */
+    _flushQueuedSideEffects: () => void;
+}
+
+export { ActiveHeadEntry, Base, BaseBodyAttr, BaseHtmlAttr, BodyAttributes, CreateHeadOptions, EntryAugmentation, EntryResolveCtx, Head, HeadClient, HeadEntry, HeadEntryOptions, HeadHooks, HeadPlugin, HeadTag, HeadTagKeys, HookResult, HtmlAttributes, InnerContent, Link, MaybeArray, Meta, Never, Noscript, ResolvesDuplicates, RuntimeMode, SchemaAugmentations, Script, SideEffectsRecord, Style, TagInternalProperties, TagPosition, TagPriority, TagUserProperties, Title, TitleTemplate, UserAttributesConfig, UserTagConfigWithoutInnerContent };

package/dist/index.mjs

@@ -1 +1 @@
-export { MergeHead } from '@zhead/schema';
+

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@unhead/schema",
   "type": "module",
-  "version": "0.0.6",
+  "version": "0.1.0",
   "packageManager": "pnpm@7.14.0",
   "author": "Harlan Wilton <harlan@harlanzw.com>",
   "license": "MIT",
@@ -33,7 +33,8 @@
     "dist"
   ],
   "dependencies": {
-    "@zhead/schema": "1.0.0-beta.4"
+    "@zhead/schema": "1.0.0-beta.4",
+    "hookable": "^5.4.1"
   },
   "scripts": {
     "build": "unbuild .",