fix: deprecate @unhead/shared (#484)

harlan-zw · web-flow · commit 743431639355 · 2025-02-12T13:47:44.000+11:00
* fix: deprecate `@unhead/schema`

* doc: missing migration

* fix: deprecate `@unhead/shared`
diff --git a/bench/templateParams.bench.ts b/bench/templateParams.bench.ts
@@ -1,5 +1,5 @@
-import { processTemplateParams } from '@unhead/shared'
 import { bench, describe } from 'vitest'
+import { processTemplateParams } from '../src/templateParams'
 
 describe('processTemplateParams', () => {
   bench('basic', () => {
diff --git a/examples/nuxt3/nuxt.config.ts b/examples/nuxt3/nuxt.config.ts
@@ -7,7 +7,6 @@ const rootDir = fileURLToPath(new URL('../../', import.meta.url))
 // https://v3.nuxtjs.org/api/configuration/nuxt.config
 export default defineNuxtConfig({
   alias: {
-    '@unhead/shared': `${rootDir}/packages/shared/src`,
     '@unhead/vue': `${rootDir}/packages/vue/src`,
     '@unhead/ssr': `${rootDir}/packages/ssr/src`,
     '@unhead/dom': `${rootDir}/packages/dom/src`,
diff --git a/package.json b/package.json
@@ -39,7 +39,8 @@
     "unbuild": "^3.3.1",
     "utility-types": "^3.11.0",
     "vitest": "^3.0.5",
-    "vue": "^3.5.13"
+    "vue": "^3.5.13",
+    "devalue": "^5.1.1"
   },
   "resolutions": {
     "@unhead/addons": "workspace:*",
diff --git a/packages-aliased/shared/README.md b/packages-aliased/shared/README.md
@@ -0,0 +1,10 @@
+# Deprecated: `@unhead/schema`
+
+Shared utils needed for Unhead. This is deprecated and only acts as alias of `unhead/utils`.
+
+## Migration
+
+```diff
+-import { Head } from '@unhead/shared'
++import { Head } from 'unhead/utils'
+```
diff --git a/packages-aliased/shared/build.config.ts b/packages-aliased/shared/build.config.ts
diff --git a/packages-aliased/shared/package.json b/packages-aliased/shared/package.json
@@ -37,13 +37,10 @@
     "dist"
   ],
   "scripts": {
-    "build": "unbuild .",
-    "stub": "unbuild . --stub"
+    "build": "unbuild ",
+    "stub": "unbuild  --stub"
   },
   "peerDependencies": {
     "unhead": "workspace:*"
-  },
-  "dependencies": {
-    "packrup": "^0.1.2"
   }
 }
diff --git a/packages-aliased/shared/src/index.ts b/packages-aliased/shared/src/index.ts
@@ -0,0 +1 @@
+export * from 'unhead/utils'
diff --git a/packages/addons/package.json b/packages/addons/package.json
@@ -58,7 +58,6 @@
   },
   "dependencies": {
     "@rollup/pluginutils": "^5.1.4",
-    "@unhead/shared": "workspace:*",
     "estree-walker": "^3.0.3",
     "magic-string": "^0.30.17",
     "mlly": "^1.7.4",
diff --git a/packages/addons/src/unplugin/UseSeoMetaTransform.ts b/packages/addons/src/unplugin/UseSeoMetaTransform.ts
@@ -9,7 +9,7 @@ import {
   resolveMetaKeyType,
   resolveMetaKeyValue,
   resolvePackedMetaObjectValue,
-} from '@unhead/shared'
+} from 'unhead/utils'
 import { walk } from 'estree-walker'
 import MagicString from 'magic-string'
 import { findStaticImports, parseStaticImport } from 'mlly'
diff --git a/packages/angular/src/unhead/ReactivityPlugin.ts b/packages/angular/src/unhead/ReactivityPlugin.ts
@@ -1,4 +1,4 @@
-import { defineHeadPlugin } from '@unhead/shared'
+import { defineHeadPlugin } from 'unhead/utils'
 import { resolveSignalHeadInput } from './utils'
 
 export const ReactivityPlugin = defineHeadPlugin({
diff --git a/packages/angular/src/unhead/composables.ts b/packages/angular/src/unhead/composables.ts
@@ -1,7 +1,7 @@
 import type { ActiveHeadEntry, HeadEntryOptions, MergeHead } from 'unhead/types'
 import type { AngularUnhead, UseHeadInput, UseHeadOptions, UseHeadSafeInput, UseSeoMetaInput } from './types/index'
 import { DestroyRef, effect, inject, signal } from '@angular/core'
-import { unpackMeta, whitelistSafeInput } from '@unhead/shared'
+import { unpackMeta, whitelistSafeInput } from 'unhead/utils'
 import { UnheadInjectionToken } from './install'
 import { resolveSignalHeadInput } from './utils'
 
diff --git a/packages/react/package.json b/packages/react/package.json
@@ -69,7 +69,6 @@
     ]
   },
   "dependencies": {
-    "@unhead/shared": "workspace:*",
     "unhead": "workspace:*"
   },
   "devDependencies": {
diff --git a/packages/react/src/ReactReactivityPlugin.ts b/packages/react/src/ReactReactivityPlugin.ts
@@ -1,4 +1,4 @@
-import { defineHeadPlugin } from '@unhead/shared'
+import { defineHeadPlugin } from 'unhead/utils'
 import { resolveUnrefHeadInput } from './utils'
 
 export const ReactReactivityPlugin = defineHeadPlugin({
diff --git a/packages/react/src/autoImports.ts b/packages/react/src/autoImports.ts
@@ -1,4 +1,4 @@
-import { composableNames } from '@unhead/shared'
+import { composableNames } from 'unhead/utils'
 
 export const hookImports = {
   '@unhead/vue': ['useUnhead', ...composableNames],
diff --git a/packages/react/src/components.ts b/packages/react/src/components.ts
@@ -1,7 +1,7 @@
 import type { ReactNode } from 'react'
 import type { UseHeadInput } from 'unhead'
 import type { ActiveHeadEntry } from 'unhead/types'
-import { HasElementTags, TagsWithInnerContent, ValidHeadTags } from '@unhead/shared'
+import { HasElementTags, TagsWithInnerContent, ValidHeadTags } from 'unhead/utils'
 import React, { useEffect, useRef } from 'react'
 import { useUnhead } from './composables'
 
diff --git a/packages/react/src/composables.ts b/packages/react/src/composables.ts
@@ -1,6 +1,6 @@
 import type { ActiveHeadEntry, HeadEntryOptions, HeadSafe, MergeHead } from 'unhead/types'
 import type { UseHeadInput, UseSeoMetaInput } from './types'
-import { unpackMeta, whitelistSafeInput } from '@unhead/shared'
+import { unpackMeta, whitelistSafeInput } from 'unhead/utils'
 import { useContext, useEffect } from 'react'
 import { UnheadContext } from './context'
 
diff --git a/packages/schema-org/package.json b/packages/schema-org/package.json
@@ -66,7 +66,6 @@
     }
   },
   "dependencies": {
-    "@unhead/shared": "workspace:*",
     "@unhead/vue": "workspace:*",
     "defu": "^6.1.4",
     "ohash": "^1.1.4",
diff --git a/packages/schema-org/src/core/resolve.ts b/packages/schema-org/src/core/resolve.ts
@@ -7,7 +7,7 @@ import type {
 } from '../types'
 import type { ResolverOptions } from '../utils'
 import type { SchemaOrgGraph } from './graph'
-import { hashCode } from '@unhead/shared'
+import { hashCode } from 'unhead/utils'
 import { hasTrailingSlash, joinURL, withoutTrailingSlash, withTrailingSlash } from 'ufo'
 import { loadResolver } from '../resolver'
 import { asArray, idReference, prefixId, setIfEmpty, stripEmptyProperties } from '../utils'
diff --git a/packages/schema-org/src/plugin.ts b/packages/schema-org/src/plugin.ts
@@ -1,6 +1,6 @@
 import type { SchemaOrgGraph } from './core/graph'
 import type { MetaInput, ResolvedMeta } from './types'
-import { defineHeadPlugin, processTemplateParams } from '@unhead/shared'
+import { defineHeadPlugin, processTemplateParams } from 'unhead/utils'
 import { defu } from 'defu'
 import {
   createSchemaOrgGraph,
diff --git a/packages/scripts/package.json b/packages/scripts/package.json
@@ -63,8 +63,5 @@
     "unhead": {
       "optional": true
     }
-  },
-  "dependencies": {
-    "@unhead/shared": "workspace:*"
   }
 }
diff --git a/packages/scripts/src/useScript.ts b/packages/scripts/src/useScript.ts
@@ -13,7 +13,7 @@ import type {
   UseScriptReturn,
   WarmupStrategy,
 } from './types'
-import { hashCode, ScriptNetworkEvents } from '@unhead/shared'
+import { hashCode, ScriptNetworkEvents } from 'unhead/utils'
 import { createForwardingProxy, createNoopedRecordingProxy, replayProxyRecordings } from './proxy'
 
 export function resolveScriptKey(input: UseScriptResolvedInput) {
diff --git a/packages/shared/README.md b/packages/shared/README.md
diff --git a/packages/unhead/build.config.ts b/packages/unhead/build.config.ts
@@ -10,5 +10,6 @@ export default defineBuildConfig({
     { input: 'src/client/index', name: 'client' },
     { input: 'src/legacy', name: 'legacy' },
     { input: 'src/types', name: 'types' },
+    { input: 'src/utils', name: 'utils' },
   ],
 })
diff --git a/packages/unhead/package.json b/packages/unhead/package.json
@@ -45,6 +45,10 @@
       "types": "./dist/legacy.d.ts",
       "import": "./dist/legacy.mjs"
     },
+    "./utils": {
+      "types": "./dist/utils.d.ts",
+      "import": "./dist/utils.mjs"
+    },
     "./types": {
       "types": "./dist/types.d.ts",
       "import": "./dist/types.mjs"
@@ -69,6 +73,9 @@
       ],
       "types": [
         "dist/types"
+      ],
+      "utils": [
+        "dist/utils"
       ]
     }
   },
@@ -78,17 +85,15 @@
     "legacy.d.ts",
     "plugins.d.ts",
     "server.d.ts",
-    "types.d.ts"
+    "types.d.ts",
+    "utils.d.ts"
   ],
   "scripts": {
-    "build": "unbuild .",
-    "stub": "unbuild . --stub"
+    "build": "unbuild",
+    "stub": "unbuild --stub"
   },
   "dependencies": {
-    "@unhead/shared": "workspace:*",
-    "hookable": "^5.5.3"
-  },
-  "devDependencies": {
-    "devalue": "^5.1.1"
+    "hookable": "^5.5.3",
+    "packrup": "^0.1.2"
   }
 }
diff --git a/packages/unhead/src/client/createHead.ts b/packages/unhead/src/client/createHead.ts
@@ -1,5 +1,5 @@
 import type { CreateClientHeadOptions, Head } from '../types'
-import { IsBrowser } from '@unhead/shared'
+import { IsBrowser } from '../utils'
 import { createHeadCore } from '../createHead'
 import { DomPlugin } from './plugins/domPlugin'
 import { ClientEventHandlerPlugin } from './plugins/eventHandlers'
diff --git a/packages/unhead/src/client/plugins/domPlugin.ts b/packages/unhead/src/client/plugins/domPlugin.ts
@@ -1,5 +1,5 @@
 import type { DomPluginOptions } from '../../types'
-import { defineHeadPlugin } from '@unhead/shared'
+import { defineHeadPlugin } from '../../utils'
 
 export function DomPlugin(options: DomPluginOptions) {
   return defineHeadPlugin((head) => {
diff --git a/packages/unhead/src/client/plugins/eventHandlers.ts b/packages/unhead/src/client/plugins/eventHandlers.ts
@@ -1,4 +1,4 @@
-import { defineHeadPlugin, NetworkEvents } from '@unhead/shared'
+import { defineHeadPlugin, NetworkEvents } from '../../utils'
 
 const ValidEventTags = new Set(['script', 'link', 'bodyAttrs'])
 
diff --git a/packages/unhead/src/client/renderDOMHead.ts b/packages/unhead/src/client/renderDOMHead.ts
@@ -6,7 +6,7 @@ import type {
   RenderDomHeadOptions,
   Unhead,
 } from '../types'
-import { HasElementTags, hashTag, normaliseProps, tagDedupeKey } from '@unhead/shared'
+import { HasElementTags, hashTag, normaliseProps, tagDedupeKey } from '../utils'
 
 /**
  * Render the head tags to the DOM.
diff --git a/packages/unhead/src/composables.ts b/packages/unhead/src/composables.ts
@@ -7,7 +7,7 @@ import type {
   Unhead,
   UseSeoMetaInput,
 } from './types'
-import { unpackMeta, whitelistSafeInput } from '@unhead/shared'
+import { unpackMeta, whitelistSafeInput } from './utils'
 
 export type UseHeadInput<T extends MergeHead> = Head<T>
 
diff --git a/packages/unhead/src/createHead.ts b/packages/unhead/src/createHead.ts
@@ -9,7 +9,7 @@ import type {
   RuntimeMode,
   Unhead,
 } from './types'
-import { normaliseEntryTags } from '@unhead/shared'
+import { normaliseEntryTags } from './utils'
 import { createHooks } from 'hookable'
 import { DedupePlugin, SortPlugin, TemplateParamsPlugin, TitleTemplatePlugin, XSSPlugin } from './plugins'
 
diff --git a/packages/unhead/src/legacy/index.ts b/packages/unhead/src/legacy/index.ts
@@ -8,7 +8,7 @@ import type {
   Unhead,
   UseSeoMetaInput,
 } from '../types'
-import { composableNames, unpackMeta, whitelistSafeInput } from '@unhead/shared'
+import { composableNames, unpackMeta, whitelistSafeInput } from '../utils'
 import { createDebouncedFn, renderDOMHead } from 'unhead/client'
 import { DomPlugin } from '../client/plugins/domPlugin'
 import { ClientEventHandlerPlugin } from '../client/plugins/eventHandlers'
diff --git a/packages/unhead/src/legacy/useScript.ts b/packages/unhead/src/legacy/useScript.ts
@@ -1,5 +1,5 @@
 import type { ActiveHeadEntry, Head, HeadEntryOptions, Script } from '../types'
-import { hashCode, ScriptNetworkEvents } from '@unhead/shared'
+import { hashCode, ScriptNetworkEvents } from '../utils'
 import { getActiveHead } from './index'
 
 export type UseScriptInput = string | (Omit<Script, 'src'> & { src: string })
diff --git a/packages/unhead/src/plugins/dedupe.ts b/packages/unhead/src/plugins/dedupe.ts
@@ -1,5 +1,5 @@
 import type { HeadTag } from '../types'
-import { defineHeadPlugin, HasElementTags, hashTag, tagWeight } from '@unhead/shared'
+import { defineHeadPlugin, HasElementTags, hashTag, tagWeight } from '../utils'
 
 const UsesMergeStrategy = new Set(['templateParams', 'htmlAttrs', 'bodyAttrs'])
 
diff --git a/packages/unhead/src/plugins/deprecations.ts b/packages/unhead/src/plugins/deprecations.ts
@@ -1,4 +1,4 @@
-import { defineHeadPlugin } from '@unhead/shared'
+import { defineHeadPlugin } from '../utils'
 
 export const DeprecationsPlugin = defineHeadPlugin({
   hooks: {
diff --git a/packages/unhead/src/plugins/inferSeoMetaPlugin.ts b/packages/unhead/src/plugins/inferSeoMetaPlugin.ts
@@ -1,5 +1,5 @@
 import type { Head } from '../types'
-import { defineHeadPlugin, resolveTitleTemplate } from '@unhead/shared'
+import { defineHeadPlugin, resolveTitleTemplate } from '../utils'
 
 export interface InferSeoMetaPluginOptions {
   /**
diff --git a/packages/unhead/src/plugins/normalize.ts b/packages/unhead/src/plugins/normalize.ts
@@ -1,4 +1,4 @@
-import { defineHeadPlugin, normaliseEntryTags } from '@unhead/shared'
+import { defineHeadPlugin, normaliseEntryTags } from '../utils'
 
 export const NormalizePlugin = defineHeadPlugin(head => ({
   hooks: {
diff --git a/packages/unhead/src/plugins/promises.ts b/packages/unhead/src/plugins/promises.ts
@@ -1,4 +1,4 @@
-import { defineHeadPlugin } from '@unhead/shared'
+import { defineHeadPlugin } from '../utils'
 
 async function resolvePromisesRecursively(root: any): Promise<any> {
   if (root instanceof Promise) {
diff --git a/packages/unhead/src/plugins/sort.ts b/packages/unhead/src/plugins/sort.ts
@@ -1,4 +1,4 @@
-import { defineHeadPlugin, SortModifiers, tagWeight } from '@unhead/shared'
+import { defineHeadPlugin, SortModifiers, tagWeight } from '../utils'
 
 export const SortPlugin = defineHeadPlugin(head => ({
   hooks: {
diff --git a/packages/unhead/src/plugins/templateParams.ts b/packages/unhead/src/plugins/templateParams.ts
@@ -1,5 +1,5 @@
 import type { HeadTag, TemplateParams } from '../types'
-import { defineHeadPlugin, processTemplateParams } from '@unhead/shared'
+import { defineHeadPlugin, processTemplateParams } from '../utils'
 
 const SupportedAttrs = {
   meta: 'content',
diff --git a/packages/unhead/src/plugins/titleTemplate.ts b/packages/unhead/src/plugins/titleTemplate.ts
@@ -1,5 +1,5 @@
 import type { HeadTag } from '../types'
-import { defineHeadPlugin, resolveTitleTemplate } from '@unhead/shared'
+import { defineHeadPlugin, resolveTitleTemplate } from '../utils'
 
 export const TitleTemplatePlugin = defineHeadPlugin({
   hooks: {
diff --git a/packages/unhead/src/plugins/xss.ts b/packages/unhead/src/plugins/xss.ts
@@ -1,4 +1,4 @@
-import { defineHeadPlugin } from '@unhead/shared'
+import { defineHeadPlugin } from '../utils'
 
 export const XSSPlugin = defineHeadPlugin({
   hooks: {
diff --git a/packages/unhead/src/server/plugins/eventHandlers.ts b/packages/unhead/src/server/plugins/eventHandlers.ts
@@ -1,4 +1,4 @@
-import { defineHeadPlugin, hashCode, NetworkEvents } from '@unhead/shared'
+import { defineHeadPlugin, hashCode, NetworkEvents } from '../../utils'
 
 const ValidEventTags = new Set(['script', 'link', 'bodyAttrs'])
 
diff --git a/packages/unhead/src/server/plugins/payload.ts b/packages/unhead/src/server/plugins/payload.ts
@@ -1,4 +1,4 @@
-import { defineHeadPlugin } from '@unhead/shared'
+import { defineHeadPlugin } from '../../utils'
 
 export const PayloadPlugin = defineHeadPlugin({
   hooks: {
diff --git a/packages/unhead/src/server/util/tagToString.ts b/packages/unhead/src/server/util/tagToString.ts
@@ -1,5 +1,5 @@
 import type { HeadTag } from '../../types'
-import { SelfClosingTags, TagsWithInnerContent } from '@unhead/shared'
+import { SelfClosingTags, TagsWithInnerContent } from '../../utils'
 import { propsToString } from './propsToString'
 
 export function escapeHtml(str: string) {
diff --git a/packages/unhead/src/utils/constants.ts b/packages/unhead/src/utils/constants.ts
diff --git a/packages/unhead/src/utils/defineHeadPlugin.ts b/packages/unhead/src/utils/defineHeadPlugin.ts
diff --git a/packages/unhead/src/utils/hashCode.ts b/packages/unhead/src/utils/hashCode.ts
diff --git a/packages/unhead/src/utils/index.ts b/packages/unhead/src/utils/index.ts
diff --git a/packages/unhead/src/utils/meta.ts b/packages/unhead/src/utils/meta.ts
diff --git a/packages/unhead/src/utils/normalise.ts b/packages/unhead/src/utils/normalise.ts
diff --git a/packages/unhead/src/utils/safe.ts b/packages/unhead/src/utils/safe.ts
diff --git a/packages/unhead/src/utils/sort.ts b/packages/unhead/src/utils/sort.ts
diff --git a/packages/unhead/src/utils/tagDedupeKey.ts b/packages/unhead/src/utils/tagDedupeKey.ts
diff --git a/packages/unhead/src/utils/templateParams.ts b/packages/unhead/src/utils/templateParams.ts
diff --git a/packages/unhead/src/utils/titleTemplate.ts b/packages/unhead/src/utils/titleTemplate.ts
diff --git a/packages/unhead/src/utils/utils.ts b/packages/unhead/src/utils/utils.ts
diff --git a/packages/unhead/utils.d.ts b/packages/unhead/utils.d.ts
@@ -0,0 +1 @@
+export * from './dist/utils'
diff --git a/packages/vue/package.json b/packages/vue/package.json
@@ -88,7 +88,6 @@
     ]
   },
   "dependencies": {
-    "@unhead/shared": "workspace:*",
     "hookable": "^5.5.3",
     "unhead": "workspace:*"
   }
diff --git a/packages/vue/src/VueReactivityPlugin.ts b/packages/vue/src/VueReactivityPlugin.ts
@@ -1,4 +1,4 @@
-import { defineHeadPlugin } from '@unhead/shared'
+import { defineHeadPlugin } from 'unhead/utils'
 import { resolveUnrefHeadInput } from './utils'
 
 export const VueReactivityPlugin = defineHeadPlugin({
diff --git a/packages/vue/src/autoImports.ts b/packages/vue/src/autoImports.ts
@@ -1,4 +1,4 @@
-import { composableNames } from '@unhead/shared'
+import { composableNames } from 'unhead/utils'
 
 export const unheadVueComposablesImports = {
   '@unhead/vue': ['injectHead', ...composableNames],
diff --git a/packages/vue/src/composables.ts b/packages/vue/src/composables.ts
diff --git a/packages/vue/src/legacy/index.ts b/packages/vue/src/legacy/index.ts
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import { defineHeadPlugin } from '@unhead/shared'`
	`1`	`+import { defineHeadPlugin } from 'unhead/utils'`
`2`	`2`	`import { resolveSignalHeadInput } from './utils'`
`3`	`3`
`4`	`4`	`export const ReactivityPlugin = defineHeadPlugin({`