chore!: drop deprecated functions and composables (#3514)

* chore!: drop deprecated functions and composables

* fix: remove unused export

* test: remove import

Author: BobbieGoede

docs/content/docs/02.guide/90.migrating.md

@@ -5,6 +5,16 @@ description: Follow this guide to upgrade from one major version to the other.
 
 ## Upgrading from `nuxtjs/i18n` v9.x to v10.x
 
+### Dropped Nuxt context functions
+
+The following functions have been removed from the Nuxt context.
+* `$resolveRoute()`{lang="ts"}
+* `$localeLocation()`{lang="ts"}
+
+Steps to migrate
+* `$resolveRoute()`{lang="ts"} -> use `$localeRoute()` instead
+* `$localeLocation()`{lang="ts"} -> use `$localeRoute()` instead
+
 ### Drop `bundle.optimizeTranslationDirective`
 This feature has been disabled and the option to enable it has been removed, see [the discussion in this issue](https://github.com/nuxt-modules/i18n/issues/3238#issuecomment-2672492536) for context on this change.
 

specs/fixtures/routing/pages/index.vue

@@ -1,8 +1,7 @@
 <script lang="ts" setup>
-import { useLocaleLocation, useLocalePath, useLocaleRoute } from '#i18n'
+import { useLocalePath, useLocaleRoute } from '#i18n'
 
 const localePath = useLocalePath()
-const localeLocation = useLocaleLocation()
 const localeRoute = useLocaleRoute()
 </script>
 
@@ -66,21 +65,6 @@ const localeRoute = useLocaleRoute()
         <span class="undefined-name-ja">{{ JSON.stringify(localeRoute('vue-i18n', 'ja')) }}</span>
       </section>
     </ClientOnly>
-    <ClientOnly>
-      <section id="locale-location">
-        <span class="index">{{ JSON.stringify(localeLocation('/')) }}</span>
-        <span class="index-name-ja">{{ JSON.stringify(localeLocation('index', 'ja')) }}</span>
-        <span class="about-name">{{ JSON.stringify(localeLocation('about')) }}</span>
-        <span class="about-ja">{{ JSON.stringify(localeLocation('/about', 'ja')) }}</span>
-        <span class="about-name-ja">{{ JSON.stringify(localeLocation('about', 'ja')) }}</span>
-        <span class="about-object-ja">{{ JSON.stringify(localeLocation({ name: 'about' }, 'ja')) }}</span>
-        <span class="path-match-ja">{{ JSON.stringify(localeLocation('/:pathMatch(.*)*', 'ja')) }}</span>
-        <span class="path-match-name">{{ JSON.stringify(localeLocation('pathMatch')) }}</span>
-        <span class="path-match-name-ja">{{ JSON.stringify(localeLocation('pathMatch', 'ja')) }}</span>
-        <span class="undefined-path-ja">{{ JSON.stringify(localeRoute('/vue-i18n', 'ja')) }}</span>
-        <span class="undefined-name-ja">{{ JSON.stringify(localeRoute('vue-i18n', 'ja')) }}</span>
-      </section>
-    </ClientOnly>
   </div>
 </template>
 

specs/routing/composition.spec.ts

@@ -2,7 +2,7 @@ import { fileURLToPath } from 'node:url'
 import { describe, it } from 'vitest'
 
 import { setup } from '../utils'
-import { localeLocationTests, localeRouteTests, switchLocalePathTests } from './routing-tests'
+import { localeRouteTests, switchLocalePathTests } from './routing-tests'
 
 await setup({
   rootDir: fileURLToPath(new URL(`../fixtures/routing`, import.meta.url)),
@@ -22,12 +22,6 @@ describe('localeRoute', async () => {
   })
 })
 
-describe('localeLocation', async () => {
-  it('should work', async () => {
-    await localeLocationTests()
-  })
-})
-
 describe('switchLocalePath', async () => {
   it('should work', async () => {
     await switchLocalePathTests()

specs/routing/legacy.spec.ts

@@ -2,7 +2,7 @@ import { fileURLToPath } from 'node:url'
 import { describe, it } from 'vitest'
 
 import { setup } from '../utils'
-import { localeLocationTests, localeRouteTests, switchLocalePathTests } from './routing-tests'
+import { localeRouteTests, switchLocalePathTests } from './routing-tests'
 
 await setup({
   rootDir: fileURLToPath(new URL(`../fixtures/routing`, import.meta.url)),
@@ -23,12 +23,6 @@ describe('localeRoute', async () => {
   })
 })
 
-describe('localeLocation', async () => {
-  it('should work', async () => {
-    await localeLocationTests()
-  })
-})
-
 describe('switchLocalePath', async () => {
   it('should work', async () => {
     await switchLocalePathTests()

specs/routing/routing-tests.ts

@@ -124,86 +124,6 @@ export async function switchLocalePathTests() {
   // expect(await getText(page, '#switch-locale-path .en')).toEqual('/en/not-found-english')
 }
 
-export async function localeLocationTests() {
-  const { page } = await renderPage('/en')
-
-  expect(JSON.parse(await getText(page, '#locale-location .index'))).include({
-    fullPath: '/en',
-    path: '/en',
-    name: 'index___en',
-    href: '/en'
-  })
-
-  expect(JSON.parse(await getText(page, '#locale-location .index-name-ja'))).include({
-    fullPath: '/ja',
-    path: '/ja',
-    name: 'index___ja',
-    href: '/ja'
-  })
-
-  expect(JSON.parse(await getText(page, '#locale-location .about-name'))).include({
-    fullPath: '/en/about',
-    path: '/en/about',
-    name: 'about___en',
-    href: '/en/about'
-  })
-
-  expect(JSON.parse(await getText(page, '#locale-location .about-ja'))).include({
-    fullPath: '/ja/about',
-    path: '/ja/about',
-    name: 'about___ja',
-    href: '/ja/about'
-  })
-
-  expect(JSON.parse(await getText(page, '#locale-location .about-name-ja'))).include({
-    fullPath: '/ja/about',
-    path: '/ja/about',
-    name: 'about___ja',
-    href: '/ja/about'
-  })
-
-  expect(JSON.parse(await getText(page, '#locale-location .path-match-ja'))).include({
-    fullPath: '/ja/:pathMatch(.*)*',
-    path: '/ja/:pathMatch(.*)*',
-    name: 'pathMatch___ja',
-    href: '/ja/:pathMatch(.*)*'
-  })
-
-  // name
-  expect(JSON.parse(await getText(page, '#locale-location .path-match-name'))).include({
-    fullPath: '/en',
-    path: '/en',
-    name: 'pathMatch___en',
-    href: '/en'
-  })
-
-  expect(JSON.parse(await getText(page, '#locale-location .path-match-name-ja'))).include({
-    fullPath: '/ja',
-    path: '/ja',
-    name: 'pathMatch___ja',
-    href: '/ja'
-  })
-
-  // object
-  expect(JSON.parse(await getText(page, '#locale-location .about-object-ja'))).include({
-    fullPath: '/ja/about',
-    path: '/ja/about',
-    name: 'about___ja',
-    href: '/ja/about'
-  })
-
-  // undefined path
-  expect(JSON.parse(await getText(page, '#locale-location .undefined-path-ja'))).include({
-    fullPath: '/ja/vue-i18n',
-    path: '/ja/vue-i18n',
-    name: 'pathMatch___ja',
-    href: '/ja/vue-i18n'
-  })
-
-  // undefined name
-  expect(await getText(page, '#locale-location .undefined-name-ja')).toEqual('')
-}
-
 export async function localeRouteTests() {
   const { page } = await renderPage('/en')
 

src/runtime/composables/index.ts

@@ -6,15 +6,8 @@ import { _useLocaleHead, _useSetI18nParams } from '../routing/head'
 import { getRouteBaseName, localePath, localeRoute, switchLocalePath } from '../routing/routing'
 import type { Ref } from 'vue'
 import type { Locale } from 'vue-i18n'
-import type { resolveRoute } from '../routing/routing'
 import type { I18nHeadMetaInfo, I18nHeadOptions, SeoAttributesOptions } from '#internal-i18n-types'
-import type {
-  RouteLocationAsRelativeI18n,
-  RouteLocationRaw,
-  RouteLocationResolvedI18n,
-  RouteMap,
-  RouteMapI18n
-} from 'vue-router'
+import type { RouteLocationAsRelativeI18n, RouteLocationResolvedI18n, RouteMap, RouteMapI18n } from 'vue-router'
 import type { RouteLocationGenericPath, I18nRouteMeta } from '../types'
 
 export * from 'vue-i18n'
@@ -74,18 +67,6 @@ export function useLocaleHead({
 
 type RouteLocationI18nGenericPath = Omit<RouteLocationAsRelativeI18n, 'path'> & { path?: string }
 
-/**
- * Revoles a localized route object for the passed route.
- *
- * @param route - a route name or route object.
- * @param locale - (default: current locale).
- *
- * @returns Localized route object
- *
- * @deprecated use {@link useLocalePath}/{@link LocalePathFunction $localePath} or {@link useLocaleRoute}/{@link LocaleRouteFunction $localeRoute} instead
- */
-export type ResolveRouteFunction = (route: RouteLocationRaw, locale?: Locale) => ReturnType<typeof resolveRoute>
-
 /**
  * Resolves the route base name for the given route.
  *
@@ -146,32 +127,6 @@ export function useLocaleRoute(): LocaleRouteFunction {
   return wrapComposable(localeRoute)
 }
 
-/**
- * Resolves a localized variant of the passed route.
- *
- * @param route - a route name or route object.
- * @param locale - (default: current locale).
- *
- * @returns A resolved route object
- *
- * @deprecated use {@link useLocaleRoute}/{@link LocaleRouteFunction $localeRoute} instead
- */
-export type LocaleLocationFunction = <Name extends keyof RouteMapI18n = keyof RouteMapI18n>(
-  route: Name | RouteLocationI18nGenericPath,
-  locale?: Locale
-) => RouteLocationResolvedI18n<Name> | undefined
-
-/**
- * Returns a {@link LocaleLocationFunction} used to resolve localized route objects.
- *
- * @deprecated use {@link useLocaleRoute}/{@link LocaleRouteFunction $localeRoute} instead
- */
-export function useLocaleLocation(): LocaleLocationFunction {
-  // we wrap `localeRoute` as the implementation is identical
-  // @ts-expect-error - generated types conflict with the generic types we accept
-  return wrapComposable(localeRoute)
-}
-
 /**
  * Resolves a localized variant of the current path.
  *

src/runtime/plugins/i18n.ts

@@ -22,15 +22,14 @@ import { createLocaleFromRouteGetter } from '../routing/utils'
 import { extendI18n } from '../routing/i18n'
 import { createLogger } from '#nuxt-i18n/logger'
 import { getI18nTarget } from '../compatibility'
-import { resolveRoute } from '../routing/routing'
 import { localeHead } from '../routing/head'
-import { useLocalePath, useLocaleRoute, useRouteBaseName, useSwitchLocalePath, useLocaleLocation } from '../composables'
+import { useLocalePath, useLocaleRoute, useRouteBaseName, useSwitchLocalePath } from '../composables'
 import { getDefaultLocaleForDomain, setupMultiDomainLocales } from '../domain'
 
 import type { Locale, I18nOptions, Composer } from 'vue-i18n'
 import type { NuxtApp } from '#app'
 import type { LocaleObject, I18nPublicRuntimeConfig } from '#internal-i18n-types'
-import type { LocaleHeadFunction, ResolveRouteFunction } from '../composables'
+import type { LocaleHeadFunction } from '../composables'
 
 export default defineNuxtPlugin({
   name: 'i18n:plugin',
@@ -212,11 +211,7 @@ export default defineNuxtPlugin({
         localePath: useLocalePath(),
         localeRoute: useLocaleRoute(),
         getRouteBaseName: useRouteBaseName(),
-        switchLocalePath: useSwitchLocalePath(),
-        // TODO: remove in v10
-        resolveRoute: wrapComposable(resolveRoute) as ResolveRouteFunction,
-        // TODO: remove in v10
-        localeLocation: useLocaleLocation()
+        switchLocalePath: useSwitchLocalePath()
       }
     }
   }

src/runtime/routing/routing.ts

@@ -111,7 +111,7 @@ function resolveRouteObject(common: CommonComposableOptions, route: RouteLike, l
   return route
 }
 
-export function resolveRoute(common: CommonComposableOptions, route: RouteLocationRaw, locale?: Locale) {
+function resolveRoute(common: CommonComposableOptions, route: RouteLocationRaw, locale?: Locale) {
   try {
     const _locale = locale || unref(getI18nTarget(common.i18n).locale)
     const normalized = normalizeRawLocation(route)