Merge branch 'main' into renovate/major-vitest-monorepo

Author: DamianGlowala

README.md

@@ -14,12 +14,9 @@ See [demo on CodeSandbox](https://codesandbox.io/s/github/nuxt-community/device-
 ## Installation
 
 ```bash
-npx nuxi@latest module add device
+npx nuxt module add device
 ```
 
-> [!NOTE]
-> You can find the Nuxt 2 version of the module on the [`2.x` branch](https://github.com/nuxt-modules/device/tree/2.x).
-
 ## Flags
 
 You can use the following flags to detect the device type:
@@ -84,17 +81,6 @@ definePageMeta({
 </script>
 ```
 
-<!-- ### Adding a Custom Flag
-
-You can add other flags to `$device` by adding a [Nuxt plugin](https://nuxtjs.org/docs/2.x/directory-structure/plugins):
-
-```js
-// plugins/custom-flag.js
-export default function ({ $device }) {
-  $device.isCustom = $device.userAgent.includes('Custom-Agent') ? true : false
-}
-``` -->
-
 ### Options
 
 #### `defaultUserAgent`
@@ -103,24 +89,6 @@ Sets the default value for the `user-agent` header (useful when running `npm run
 
 Default: `Mozilla/5.0 (Macintosh; Intel Mac OS X 10_13_2) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/64.0.3282.39 Safari/537.36`
 
-#### `enabled`
-
-Enables the module conditionally.
-
-Default: `true`
-
-> [!WARNING]
-> This option is deprecated. It will be removed in the next major release.
-
-#### `refreshOnResize`
-
-Refreshes flags on window resize.
-
-Default: `false`
-
-> [!WARNING]
-> This option is deprecated. It will be removed in the next major release.
-
 ## Amazon CloudFront Support
 
 If the user agent is `Amazon CloudFront`, the module checks for the following headers:  

package.json

@@ -4,10 +4,9 @@
     "description": "Device detection module for Nuxt",
     "repository": {
         "type": "git",
-        "url": "git+https://github.com/nuxt-modules/device"
+        "url": "git+https://github.com/nuxt-modules/device.git"
     },
     "license": "MIT",
-    "author": "Shinji Yamada <dotneet@gmail.com>",
     "type": "module",
     "exports": {
         ".": {

src/module.ts

@@ -1,5 +1,5 @@
 import { defu } from 'defu'
-import { defineNuxtModule, addPlugin, addImportsDir, createResolver, useLogger, addTemplate } from '@nuxt/kit'
+import { defineNuxtModule, addPlugin, addImportsDir, createResolver, addTemplate } from '@nuxt/kit'
 import crawlers from 'crawler-user-agents' with { type: 'json' }
 import { name, version } from '../package.json'
 import type { ModuleOptions } from './types'
@@ -14,26 +14,8 @@ export default defineNuxtModule<ModuleOptions>({
     version,
   },
   setup(options, nuxt) {
-    if (typeof options.enabled === 'boolean' || typeof options.refreshOnResize === 'boolean') {
-      const logger = useLogger('@nuxtjs/device')
-
-      if (typeof options.enabled === 'boolean') {
-        logger.warn('\'enabled\' option is deprecated. It will be removed in the next major release.')
-      }
-
-      if (typeof options.refreshOnResize === 'boolean') {
-        logger.warn('\'refreshOnResize\' option is deprecated. It will be removed in the next major release.')
-      }
-    }
-
-    if (options.enabled === false) {
-      return
-    }
-
     nuxt.options.runtimeConfig.public.device = defu(nuxt.options.runtimeConfig.public.device, {
       defaultUserAgent: 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_13_2) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/64.0.3282.39 Safari/537.36',
-      enabled: true,
-      refreshOnResize: false,
     })
 
     const { resolve } = createResolver(import.meta.url)

src/runtime/plugin.ts

@@ -20,19 +20,6 @@ export default defineNuxtPlugin(() => {
     const userAgent = navigator.userAgent || defaultUserAgent
 
     flags = reactive(generateFlags(userAgent))
-
-    if (runtimeConfig.public.device.refreshOnResize) {
-      window.addEventListener('resize', () => {
-        setTimeout(() => {
-          const newFlags = generateFlags(navigator.userAgent || userAgent)
-
-          Object.entries(newFlags).forEach(([key, value]) => {
-          // eslint-disable-next-line @typescript-eslint/no-explicit-any
-            (flags as any)[key] = value
-          })
-        }, 50)
-      })
-    }
   }
 
   return {

src/types.ts

@@ -4,20 +4,6 @@ export interface ModuleOptions {
    * @default 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_13_2) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/64.0.3282.39 Safari/537.36'
    */
   defaultUserAgent?: string
-
-  /**
-   * Enables the module conditionally.
-   * @default true
-   * @deprecated
-   */
-  enabled?: boolean
-
-  /**
-   * Refreshes flags on window resize.
-   * @default false
-   * @deprecated
-   */
-  refreshOnResize?: boolean
 }
 
 declare module '@nuxt/schema' {