@nuxt/devtools-onboard 0.0.0-stage → 4.0.0-beta.4

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022-PRESENT Nuxt Team
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,24 @@
-# Temporary Holding Version
+# @nuxt/devtools-onboard
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+The entry point of [Nuxt DevTools](https://devtools.nuxt.com). It is a tiny Nuxt module that Nuxt 5 ships instead of depending on `@nuxt/devtools` directly:
+
+- when `@nuxt/devtools` is installed in your project, it loads it;
+- when it is not, `nuxt dev` shows a floating button (built on [`@devframes/hub-ui-onboard`](https://devfra.me/guide/hub-ui-onboard)) that installs it with your package manager and restarts the dev server, so the real DevTools dock takes its place.
+
+Nothing is injected outside `nuxt dev`.
+
+## Turning it off
+
+- `devtools: false` (or `devtools: { enabled: false }`) in `nuxt.config` disables both the button and DevTools.
+- **Disable entirely** in the button's panel writes `node_modules/.devframe/hub-ui-onboard.json`; the button stays hidden on later starts until you delete that file or set the `devtools` option explicitly.
+- **Hide for now** hides the button for the current tab only.
+
+## Nuxt 4
+
+Nuxt 4 depends on `@nuxt/devtools` itself, so this package is not needed there. Adding it to `modules` still works: it loads the installed DevTools and never shows the button.
+
+```ts
+export default defineNuxtConfig({
+  modules: ['@nuxt/devtools-onboard'],
+})
+```

package/dist/module.d.mts

@@ -0,0 +1,5 @@
+import * as _nuxt_schema from '@nuxt/schema';
+
+declare const _default: _nuxt_schema.NuxtModule<_nuxt_schema.ModuleOptions, _nuxt_schema.ModuleOptions, false>;
+
+export { _default as default };

package/dist/module.json

@@ -0,0 +1,9 @@
+{
+  "name": "@nuxt/devtools-onboard",
+  "configKey": "@nuxt/devtools-onboard",
+  "version": "4.0.0-beta.4",
+  "builder": {
+    "@nuxt/module-builder": "1.0.3",
+    "unbuild": "3.6.1"
+  }
+}

package/dist/module.mjs

@@ -0,0 +1,61 @@
+import { fileURLToPath } from 'node:url';
+import { createOnboarding } from '@devframes/hub-ui-onboard';
+import { defineNuxtModule, tryResolveModule, installModule } from '@nuxt/kit';
+import { readPackageJSON } from 'pkg-types';
+
+const DEVTOOLS = "@nuxt/devtools";
+const DEVTOOLS_MODULES = /* @__PURE__ */ new Set([DEVTOOLS, `${DEVTOOLS}-nightly`, `${DEVTOOLS}-edge`]);
+function listsDevtools(modules) {
+  return modules.some((entry) => {
+    const id = Array.isArray(entry) ? entry[0] : entry;
+    return typeof id === "string" && DEVTOOLS_MODULES.has(id);
+  });
+}
+async function devtoolsSpec() {
+  const { version, peerDependencies } = await readPackageJSON(fileURLToPath(import.meta.url));
+  const range = peerDependencies?.[DEVTOOLS] ?? "";
+  return `${DEVTOOLS}@${range.startsWith("npm:") ? range : `^${version}`}`;
+}
+const module$1 = defineNuxtModule({
+  meta: {
+    name: "@nuxt/devtools-onboard"
+  },
+  async setup(_, nuxt) {
+    const { devtools } = nuxt.options;
+    if (devtools === false || typeof devtools === "object" && devtools.enabled === false)
+      return;
+    if (listsDevtools(nuxt.options.modules))
+      return;
+    const installed = await tryResolveModule(DEVTOOLS, nuxt.options.modulesDir);
+    if (installed)
+      return installModule(installed);
+    if (!nuxt.options.dev)
+      return;
+    const onboarding = createOnboarding({
+      cwd: nuxt.options.rootDir,
+      // Where Vite DevTools mounts the hub, so after the restart the real
+      // `embedded.js` answers at the URL the button was loaded from.
+      base: "/__devtools/",
+      packages: [await devtoolsSpec()],
+      branding: {
+        productName: "Nuxt DevTools",
+        primaryColor: "#099e61",
+        logo: "https://nuxt.com/assets/design-kit/icon-green.svg"
+      },
+      messages: {
+        restart: "Installed. Restarting the dev server\u2026"
+      },
+      onInstalled() {
+        setTimeout(() => nuxt.callHook("restart", { hard: true }), 100);
+      }
+    });
+    nuxt.hook("vite:serverCreated", (server, { isClient }) => {
+      if (isClient)
+        server.middlewares.use(onboarding.nodeMiddleware);
+    });
+    if (!onboarding.disabled)
+      (nuxt.options.app.head.script ??= []).push({ type: "module", src: onboarding.scriptSrc, tagPosition: "bodyClose" });
+  }
+});
+
+export { module$1 as default };

package/dist/types.d.mts

@@ -0,0 +1,7 @@
+import type { NuxtModule } from '@nuxt/schema'
+
+import type { default as Module } from './module.mjs'
+
+export type ModuleOptions = typeof Module extends NuxtModule<infer O> ? Partial<O> : Record<string, any>
+
+export { default } from './module.mjs'

package/package.json

@@ -1,6 +1,43 @@
 {
   "name": "@nuxt/devtools-onboard",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "type": "module",
+  "version": "4.0.0-beta.4",
+  "description": "The entry point of Nuxt DevTools: loads it when installed, otherwise offers to install it from a floating button.",
+  "license": "MIT",
+  "homepage": "https://devtools.nuxt.com",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/nuxt/devtools.git",
+    "directory": "packages/devtools-onboard"
+  },
+  "exports": {
+    ".": "./dist/module.mjs"
+  },
+  "types": "./dist/module.d.mts",
+  "files": [
+    "dist"
+  ],
+  "peerDependencies": {
+    "@nuxt/devtools": "^4.0.0-beta.4",
+    "@nuxt/kit": "^4.0.0-0 || ^5.0.0-0"
+  },
+  "peerDependenciesMeta": {
+    "@nuxt/devtools": {
+      "optional": true
+    }
+  },
+  "dependencies": {
+    "@devframes/hub-ui-onboard": "^1.2.0",
+    "pkg-types": "^2.3.3"
+  },
+  "devDependencies": {
+    "@nuxt/kit": "npm:@nuxt/kit-nightly@5.0.0-2610052343-36eafab",
+    "@nuxt/schema": "npm:@nuxt/schema-nightly@5.0.0-2610052343-36eafab",
+    "nuxt": "npm:nuxt-nightly@5.0.0-2610052343-36eafab"
+  },
+  "scripts": {
+    "build": "nuxt-build-module build",
+    "stub": "nuxt-build-module build --stub",
+    "dev:prepare": "pnpm run stub"
+  }
 }