fix(types): make templateParams extensible via module augmentation (#679)

harlan-zw · Copilot · web-flow · commit b0627152321b · 2026-03-10T23:30:14.000+11:00
* fix(types): make templateParams extensible via module augmentation Add `templateParams` to `SchemaAugmentations` and intersect it into `ResolvableTemplateParams`, allowing users to extend templateParams via `declare module 'unhead/types' { interface SchemaAugmentations { templateParams: { foo: string } } }`. Also updates `ReactiveHead.templateParams` in the Vue package to use the shared `ResolvableTemplateParams` type. Closes #575 * fix(types): make templateParams extensible via module augmentation (#684) * Initial plan * fix(types): use dedicated TemplateParamsAugmentations interface to avoid TS2717 Co-authored-by: harlan-zw <5326365+harlan-zw@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: harlan-zw <5326365+harlan-zw@users.noreply.github.com> --------- Co-authored-by: Copilot <198982749+Copilot@users.noreply.github.com> Co-authored-by: harlan-zw <5326365+harlan-zw@users.noreply.github.com>
diff --git a/packages/unhead/src/types/schema/head.ts b/packages/unhead/src/types/schema/head.ts
@@ -73,6 +73,8 @@ import type {
 } from './script'
 import type { Style } from './style'
 
+export interface TemplateParamsAugmentations {}
+
 export interface SchemaAugmentations {
   title: TagPriority
   titleTemplate: TagPriority
@@ -147,7 +149,7 @@ export type ResolvableScript = DistributeResolvableWithEvents<Script, SchemaAugm
 export type ResolvableNoscript = ResolvableProperties<Noscript & DataKeys & SchemaAugmentations['noscript']> | string
 export type ResolvableHtmlAttributes = ResolvableProperties<UnheadHtmlAttributes & DataKeys & SchemaAugmentations['htmlAttrs']>
 export type ResolvableBodyAttributes = ResolvableProperties<UnheadBodyAttributesWithoutEvents & DataKeys & SchemaAugmentations['bodyAttrs']> & MaybeEventFnHandlers<BodyEvents>
-export type ResolvableTemplateParams = { separator?: '|' | '-' | '·' | string } & Record<string, null | string | Record<string, string>>
+export type ResolvableTemplateParams = { separator?: '|' | '-' | '·' | string } & Record<string, null | string | Record<string, string>> & TemplateParamsAugmentations
 
 export interface ResolvableHead {
   /**
diff --git a/packages/vue/src/types/schema.ts b/packages/vue/src/types/schema.ts
@@ -12,6 +12,7 @@ import type {
   MaybeEventFnHandlers,
   MetaFlat,
   Noscript,
+  ResolvableTemplateParams,
   SchemaAugmentations,
   Script,
   ScriptHttpEvents,
@@ -85,10 +86,7 @@ export interface ReactiveHead {
   /**
    * Variables used to substitute in the title and meta content.
    */
-  templateParams?: ResolvableProperties<
-    { separator?: '|' | '-' | '·' | string }
-    & Record<string, Stringable | ResolvableProperties<Record<string, Stringable>>>
-  >
+  templateParams?: ResolvableProperties<ResolvableTemplateParams>
   /**
    * 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.
