@nuxt/hints 0.0.0 → 1.0.0-alpha.1

package/dist/runtime/plugins/web-vitals/utils.d.ts

@@ -0,0 +1,35 @@
+export declare enum ImagePerformanceIssueType {
+    LazyAttrOnLCPElement = 0,
+    ImgFormat = 1,
+    FetchPriorityMissingOnLCPElement = 2,
+    HeightWidthMissingOnLCPElement = 3,
+    LoadingTooLong = 4,
+    PreloadMissingOnLCPElement = 5
+}
+type LazyAttrOnLCPElementDetails = {
+    type: ImagePerformanceIssueType.LazyAttrOnLCPElement;
+};
+type ImgFormatDetails = {
+    type: ImagePerformanceIssueType.ImgFormat;
+};
+type FetchPriorityMissingOnLCPElementDetails = {
+    type: ImagePerformanceIssueType.FetchPriorityMissingOnLCPElement;
+};
+type HeightWidthMissingOnLCPElementDetails = {
+    type: ImagePerformanceIssueType.HeightWidthMissingOnLCPElement;
+};
+type LoadingTooLongDetails = {
+    type: ImagePerformanceIssueType.LoadingTooLong;
+};
+type PreloadMissingOnLCPElementDetails = {
+    type: ImagePerformanceIssueType.PreloadMissingOnLCPElement;
+};
+export type ImagePerformanceIssueDetails = LazyAttrOnLCPElementDetails | ImgFormatDetails | FetchPriorityMissingOnLCPElementDetails | HeightWidthMissingOnLCPElementDetails | LoadingTooLongDetails | PreloadMissingOnLCPElementDetails;
+export declare enum CLSIssueType {
+    LayoutShiftTooBig = 0
+}
+type LayoutShiftTooBigDetails = {
+    type: CLSIssueType.LayoutShiftTooBig;
+};
+export type CLSIssueDetails = LayoutShiftTooBigDetails;
+export {};

package/dist/runtime/plugins/web-vitals/utils.js

@@ -0,0 +1,13 @@
+export var ImagePerformanceIssueType = /* @__PURE__ */ ((ImagePerformanceIssueType2) => {
+  ImagePerformanceIssueType2[ImagePerformanceIssueType2["LazyAttrOnLCPElement"] = 0] = "LazyAttrOnLCPElement";
+  ImagePerformanceIssueType2[ImagePerformanceIssueType2["ImgFormat"] = 1] = "ImgFormat";
+  ImagePerformanceIssueType2[ImagePerformanceIssueType2["FetchPriorityMissingOnLCPElement"] = 2] = "FetchPriorityMissingOnLCPElement";
+  ImagePerformanceIssueType2[ImagePerformanceIssueType2["HeightWidthMissingOnLCPElement"] = 3] = "HeightWidthMissingOnLCPElement";
+  ImagePerformanceIssueType2[ImagePerformanceIssueType2["LoadingTooLong"] = 4] = "LoadingTooLong";
+  ImagePerformanceIssueType2[ImagePerformanceIssueType2["PreloadMissingOnLCPElement"] = 5] = "PreloadMissingOnLCPElement";
+  return ImagePerformanceIssueType2;
+})(ImagePerformanceIssueType || {});
+export var CLSIssueType = /* @__PURE__ */ ((CLSIssueType2) => {
+  CLSIssueType2[CLSIssueType2["LayoutShiftTooBig"] = 0] = "LayoutShiftTooBig";
+  return CLSIssueType2;
+})(CLSIssueType || {});

package/dist/runtime/types.d.ts

@@ -0,0 +1,48 @@
+import type { ComponentInternalInstance, VNode, Ref } from 'vue'
+import type { LCPMetricWithAttribution, INPMetricWithAttribution, CLSMetricWithAttribution } from 'web-vitals/attribution'
+
+declare global {
+  interface Window {
+    __hints_TPC_start_time: number
+    __hints_TPC_saveTime: (script: HTMLScriptElement, startTime?: number) => void
+  }
+  interface HTMLScriptElement {
+    __hints_TPC_start_time?: number
+    __hints_TPC_end_time?: number
+    requestTime?: number
+    downloadTime?: number
+    totalNetworkTime?: number
+    parseExecuteTime?: number
+    loaded?: boolean
+  }
+  interface Element {
+    __vnode?: VNode
+  }
+}
+declare module '#app' {
+  interface RuntimeNuxtHooks {
+    'hints:scripts:added': (script: HTMLScriptElement) => void
+    'hints:scripts:loaded': (script: HTMLScriptElement) => void
+
+    'hints:webvitals:sync': (webvitals: NuxtApp['__hints']['webvitals']) => void
+    'hints:webvitals:lcp': (metric: LCPMetricWithAttribution) => void
+    'hints:webvitals:inp': (metric: INPMetricWithAttribution) => void
+    'hints:webvitals:cls': (metric: CLSMetricWithAttribution) => void
+  }
+
+  interface NuxtApp {
+    __hints_tpc: Ref<{ element: HTMLScriptElement, loaded: boolean }[]>
+    __hints: {
+      hydration: { instance: ComponentInternalInstance, vnode: VNode, htmlPreHydration: string | undefined, htmlPostHydration: string | undefined }[]
+      webvitals: {
+        lcp: Ref<LCPMetricWithAttribution[]>
+        inp: Ref<INPMetricWithAttribution[]>
+        cls: Ref<CLSMetricWithAttribution[]>
+      }
+    }
+    __tracerOverlay: typeof import('vite-plugin-vue-tracer/client/overlay')
+    __tracerRecord: typeof import('vite-plugin-vue-tracer/client/record')
+  }
+}
+
+export {}

package/dist/types.d.mts

@@ -0,0 +1,3 @@
+export { default } from './module.mjs'
+
+export { type ModuleOptions } from './module.mjs'

package/package.json

@@ -1,8 +1,63 @@
 {
   "name": "@nuxt/hints",
-  "version": "0.0.0",
+  "version": "1.0.0-alpha.1",
+  "description": "Nuxt module that shows hints for aspects of your application such as Performance, Security, and more!",
+  "repository": "https://github.com/nuxt/hints",
+  "homepage": "https://github.com/nuxt/hints",
+  "license": "MIT",
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/types.d.mts",
+      "import": "./dist/module.mjs"
+    },
+    "./runtime/*": {
+      "types": "./dist/runtime/*",
+      "import": "./dist/runtime/*"
+    }
+  },
+  "main": "./dist/module.mjs",
   "files": [
     "dist"
   ],
-  "author": "Daniel Roe <daniel@roe.dev>"
+  "dependencies": {
+    "@nuxt/devtools-kit": "^3.0.0",
+    "@nuxt/kit": "^4.1.2",
+    "h3": "1.15.4",
+    "magic-string": "^0.30.19",
+    "nitropack": "^2.12.6",
+    "shiki": "^3.13.0",
+    "sirv": "^3.0.2",
+    "unplugin": "^2.3.10",
+    "vite-plugin-vue-tracer": "^1.0.1",
+    "web-vitals": "^5.1.0"
+  },
+  "devDependencies": {
+    "@nuxt/devtools": "^3.0.0",
+    "@nuxt/devtools-ui-kit": "^3.0.0",
+    "@nuxt/eslint": "^1.9.0",
+    "@nuxt/icon": "^2.0.0",
+    "@nuxt/module-builder": "^1.0.0",
+    "@nuxt/schema": "^4.1.2",
+    "@nuxt/test-utils": "^3.19.2",
+    "@types/node": "^24.0.0",
+    "changelogen": "^0.6.0",
+    "eslint": "^9.36.0",
+    "pkg-pr-new": "0.0.60",
+    "rimraf": "^6.0.1",
+    "vitest": "^4.0.0"
+  },
+  "scripts": {
+    "client:build": "nuxi generate client",
+    "client:dev": "nuxi dev client --port 3300",
+    "dev": "nuxi dev playground",
+    "dev:build": "nuxi build playground",
+    "dev:prepare": "nuxt-module-build build --stub && nuxi prepare && nuxi prepare playground",
+    "release": "npm run lint && npm run test && npm run prepack && changelogen --release && npm publish && git push --follow-tags",
+    "lint": "eslint .",
+    "test": "vitest run",
+    "test:types": "tsc --noEmit",
+    "test:watch": "vitest watch",
+    "cleanup": "rimraf **/node_modules **/dist **/.output **/.nuxt --glob"
+  }
 }