@nuxt/scripts 0.0.0 → 0.1.1

package/dist/module.mjs

@@ -0,0 +1,289 @@
+import { useNuxt, useLogger, addDevServerHandler, defineNuxtModule, createResolver, addImportsDir, addTemplate, addPlugin, addBuildPlugin } from '@nuxt/kit';
+import { readPackageJSON } from 'pkg-types';
+import { existsSync } from 'node:fs';
+import { pathToFileURL } from 'node:url';
+import { createUnplugin } from 'unplugin';
+import { parseURL, parseQuery, joinURL, hasProtocol } from 'ufo';
+import MagicString from 'magic-string';
+import { walk } from 'estree-walker';
+import fsp from 'node:fs/promises';
+import { lazyEventHandler, eventHandler, createError } from 'h3';
+import { fetch } from 'ofetch';
+import { colors } from 'consola/utils';
+import { defu } from 'defu';
+import { join } from 'pathe';
+import { hash } from 'ohash';
+import { createStorage } from 'unstorage';
+import fsDriver from 'unstorage/drivers/fs-lite';
+
+const DEVTOOLS_UI_ROUTE = "/__nuxt-scripts";
+const DEVTOOLS_UI_LOCAL_PORT = 3030;
+function setupDevToolsUI(options, resolve, nuxt = useNuxt()) {
+  const clientPath = resolve("./client");
+  const isProductionBuild = existsSync(clientPath);
+  if (isProductionBuild) {
+    nuxt.hook("vite:serverCreated", async (server) => {
+      const sirv = await import('sirv').then((r) => r.default || r);
+      server.middlewares.use(
+        DEVTOOLS_UI_ROUTE,
+        sirv(clientPath, { dev: true, single: true })
+      );
+    });
+  } else {
+    nuxt.hook("vite:extendConfig", (config) => {
+      config.server = config.server || {};
+      config.server.proxy = config.server.proxy || {};
+      config.server.proxy[DEVTOOLS_UI_ROUTE] = {
+        target: `http://localhost:${DEVTOOLS_UI_LOCAL_PORT}${DEVTOOLS_UI_ROUTE}`,
+        changeOrigin: true,
+        followRedirects: true,
+        rewrite: (path) => path.replace(DEVTOOLS_UI_ROUTE, "")
+      };
+    });
+  }
+  nuxt.hook("devtools:customTabs", (tabs) => {
+    tabs.push({
+      // unique identifier
+      name: "nuxt-scripts",
+      // title to display in the tab
+      title: "Scripts",
+      // any icon from Iconify, or a URL to an image
+      icon: "carbon:script",
+      // iframe view
+      view: {
+        type: "iframe",
+        src: DEVTOOLS_UI_ROUTE
+      }
+    });
+  });
+}
+
+function NuxtScriptAssetBundlerTransformer(options) {
+  return createUnplugin(() => {
+    return {
+      name: "nuxt:scripts:asset-bundler-transformer",
+      enforce: "post",
+      transformInclude(id) {
+        const { pathname, search } = parseURL(decodeURIComponent(pathToFileURL(id).href));
+        const { type } = parseQuery(search);
+        if (pathname.endsWith(".vue") && (type === "script" || !search))
+          return true;
+        if (pathname.match(/\.((c|m)?j|t)sx?$/g))
+          return true;
+        if (pathname.includes("node_modules/@unhead") || pathname.includes("node_modules/vueuse"))
+          return false;
+        return false;
+      },
+      async transform(code, id) {
+        if (!code.includes("useScript"))
+          return;
+        const ast = this.parse(code);
+        const s = new MagicString(code);
+        walk(ast, {
+          enter(_node) {
+            if (_node.type === "CallExpression" && _node.callee.type === "Identifier" && _node.callee?.name === "useScript") {
+              const node = _node;
+              let scriptKey;
+              let scriptNode;
+              if (node.arguments[0].type === "Literal") {
+                scriptNode = node.arguments[0];
+                scriptKey = scriptNode.value;
+              } else if (node.arguments[0].type === "ObjectExpression") {
+                const srcProperty = node.arguments[0].properties.find(
+                  (p) => p.key?.name === "src" || p.key?.value === "src"
+                );
+                const keyProperty = node.arguments[0].properties.find(
+                  (p) => p.key?.name === "key" || p.key?.value === "key"
+                );
+                scriptKey = keyProperty?.value?.value || srcProperty?.value;
+                scriptNode = srcProperty?.value;
+              }
+              if (scriptNode) {
+                const src = scriptNode.value;
+                if (src) {
+                  let hasAssetStrategy = false;
+                  if (node.arguments[1]?.type === "ObjectExpression") {
+                    const assetStrategyProperty = node.arguments[1]?.properties.find(
+                      (p) => p.key?.name === "assetStrategy" || p.key?.value === "assetStrategy"
+                    );
+                    if (assetStrategyProperty) {
+                      if (assetStrategyProperty?.value?.value !== "bundle")
+                        return;
+                      s.remove(assetStrategyProperty.start, assetStrategyProperty.end + 1);
+                      hasAssetStrategy = true;
+                    }
+                  }
+                  hasAssetStrategy = hasAssetStrategy || options.overrides?.[scriptKey]?.assetStrategy === "bundle";
+                  if (hasAssetStrategy) {
+                    const newSrc = options.resolveScript(src);
+                    s.overwrite(scriptNode.start, scriptNode.end, `'${newSrc}'`);
+                  }
+                }
+              }
+            }
+          }
+        });
+        if (s.hasChanged()) {
+          return {
+            code: s.toString(),
+            map: s.generateMap({ includeContent: true, source: id })
+          };
+        }
+      }
+    };
+  });
+}
+
+const logger = useLogger("@nuxt/scripts");
+
+const ONE_YEAR_IN_SECONDS = 60 * 60 * 24 * 365;
+function setupPublicAssetStrategy(options = {}) {
+  const assetsBaseURL = options.prefix || "/_scripts";
+  const nuxt = useNuxt();
+  const renderedScriptSrc = /* @__PURE__ */ new Map();
+  const storage = createStorage(fsDriver({
+    base: "node_modules/.cache/nuxt/scripts"
+  }));
+  function normalizeScriptData(src) {
+    if (hasProtocol(src, { acceptRelative: true })) {
+      src = src.replace(/^\/\//, "https://");
+      const url = parseURL(src);
+      const file = [
+        `${hash(url)}.js`
+        // force an extension
+      ].filter(Boolean).join("-");
+      renderedScriptSrc.set(file, src);
+      return joinURL(assetsBaseURL, file);
+    }
+    return src;
+  }
+  addDevServerHandler({
+    route: assetsBaseURL,
+    handler: lazyEventHandler(async () => {
+      return eventHandler(async (event) => {
+        const filename = event.path.slice(1);
+        const url = renderedScriptSrc.get(event.path.slice(1));
+        if (!url)
+          throw createError({ statusCode: 404 });
+        const key = `data:scripts:${filename}`;
+        let res = await storage.getItemRaw(key);
+        if (!res) {
+          res = await fetch(url).then((r) => r.arrayBuffer()).then((r) => Buffer.from(r));
+          await storage.setItemRaw(key, res);
+        }
+        return res;
+      });
+    })
+  });
+  if (nuxt.options.dev) {
+    nuxt.options.routeRules ||= {};
+    nuxt.options.routeRules[joinURL(assetsBaseURL, "**")] = {
+      cache: {
+        maxAge: ONE_YEAR_IN_SECONDS
+      }
+    };
+  }
+  nuxt.options.nitro.publicAssets ||= [];
+  const cacheDir = join(nuxt.options.buildDir, "cache", "scripts");
+  nuxt.options.nitro.publicAssets.push();
+  nuxt.options.nitro = defu(nuxt.options.nitro, {
+    publicAssets: [{
+      dir: cacheDir,
+      maxAge: ONE_YEAR_IN_SECONDS,
+      baseURL: assetsBaseURL
+    }],
+    prerender: {
+      ignore: [assetsBaseURL]
+    }
+  });
+  nuxt.hook("nitro:init", async (nitro) => {
+    if (nuxt.options.dev)
+      return;
+    nitro.hooks.hook("rollup:before", async () => {
+      await fsp.rm(cacheDir, { recursive: true, force: true });
+      await fsp.mkdir(cacheDir, { recursive: true });
+      let banner = false;
+      for (const [filename, url] of renderedScriptSrc) {
+        const key = `data:scripts:${filename}`;
+        let res = await storage.getItemRaw(key);
+        if (!res) {
+          if (!banner) {
+            banner = true;
+            logger.info("Downloading scripts...");
+          }
+          let encoding;
+          let size = 0;
+          res = await fetch(url).then((r) => {
+            encoding = r.headers.get("content-encoding");
+            size = Number(r.headers.get("content-length") / 1024);
+            return r.arrayBuffer();
+          }).then((r) => Buffer.from(r));
+          logger.log(colors.gray(`  \u251C\u2500 ${url} \u2192 ${joinURL(assetsBaseURL, filename)} (${size.toFixed(2)} kB ${encoding})`));
+          await storage.setItemRaw(key, res);
+        }
+        await fsp.writeFile(join(cacheDir, filename), res);
+      }
+      if (banner)
+        logger.success("Scripts downloaded and cached.");
+    });
+  });
+  return { normalizeScriptData };
+}
+
+const module = defineNuxtModule({
+  meta: {
+    name: "@nuxt/scripts",
+    configKey: "scripts",
+    compatibility: {
+      nuxt: "^3.11.1",
+      bridge: false
+    }
+  },
+  defaults: {
+    enabled: true,
+    debug: false
+  },
+  async setup(config, nuxt) {
+    const { resolve } = createResolver(import.meta.url);
+    const { version } = await readPackageJSON(resolve("../package.json"));
+    if (!config.enabled) {
+      logger.debug("The module is disabled, skipping setup.");
+      return;
+    }
+    nuxt.options.alias["#nuxt-scripts"] = resolve("./runtime/types");
+    nuxt.options.runtimeConfig["nuxt-scripts"] = { version };
+    addImportsDir(resolve("./runtime/composables"));
+    if (config.globals?.length) {
+      const template = addTemplate({
+        filename: "modules/nuxt-scripts/plugin.client.mjs",
+        getContents() {
+          return `import { defineNuxtPlugin, useScript } from '#imports'
+export default defineNuxtPlugin({
+  setup() {
+          ${config.globals?.map((g) => !Array.isArray(g) ? ` useScript("${g.toString()}")` : g.length === 2 ? ` useScript(${JSON.stringify(g[0])}, ${JSON.stringify(g[1])} })` : ` useScript(${JSON.stringify(g[0])})`).join("\n")}
+})`;
+        }
+      });
+      addPlugin({
+        src: template.dst,
+        mode: "client"
+      });
+    }
+    const scriptMap = /* @__PURE__ */ new Map();
+    const { normalizeScriptData } = setupPublicAssetStrategy(config.assets);
+    addBuildPlugin(NuxtScriptAssetBundlerTransformer({
+      overrides: config.overrides,
+      resolveScript(src) {
+        if (scriptMap.has(src))
+          return scriptMap.get(src);
+        const url = normalizeScriptData(src);
+        scriptMap.set(src, url);
+        return url;
+      }
+    }));
+    if (nuxt.options.dev)
+      setupDevToolsUI(config, resolve);
+  }
+});
+
+export { module as default };

package/dist/runtime/composables/createScriptConsentTrigger.d.ts

@@ -0,0 +1,6 @@
+import type { ConsentPromiseOptions } from '../types';
+type CreateScriptConsentTriggerApi = {
+    accept: () => void;
+} & Promise<void>;
+export declare function createScriptConsentTrigger(options?: ConsentPromiseOptions): CreateScriptConsentTriggerApi;
+export {};

package/dist/runtime/composables/createScriptConsentTrigger.mjs

@@ -0,0 +1,36 @@
+import { isRef, onNuxtReady, ref, requestIdleCallback, toValue, tryUseNuxtApp, watch } from "#imports";
+export function createScriptConsentTrigger(options) {
+  if (import.meta.server)
+    return new Promise(() => {
+    });
+  const consented = ref(false);
+  const nuxtApp = tryUseNuxtApp();
+  const promise = new Promise((resolve) => {
+    watch(consented, (ready) => {
+      if (ready) {
+        const runner = nuxtApp?.runWithContext || ((cb) => cb());
+        const idleTimeout = options?.loadOnNuxtReady ? nuxtApp ? onNuxtReady : requestIdleCallback : (cb) => cb();
+        runner(() => idleTimeout(resolve));
+      }
+    });
+    if (options?.consent) {
+      if (typeof options?.consent === "boolean") {
+        consented.value = true;
+      } else if (options?.consent instanceof Promise) {
+        options?.consent.then((res) => {
+          consented.value = typeof res === "boolean" ? res : true;
+        });
+      } else if (isRef(options?.consent)) {
+        watch(options.consent, (_val) => {
+          const val = toValue(_val);
+          if (typeof val === "boolean")
+            consented.value = val;
+        }, { immediate: true });
+      }
+    }
+  });
+  promise.accept = () => {
+    consented.value = true;
+  };
+  return promise;
+}

package/dist/runtime/composables/useAnalyticsPageEvent.d.ts

@@ -0,0 +1,2 @@
+import type { TrackedPage } from '#nuxt-scripts';
+export declare function useAnalyticsPageEvent(onChange?: (payload: TrackedPage) => void): any;

package/dist/runtime/composables/useAnalyticsPageEvent.mjs

@@ -0,0 +1,35 @@
+import { injectHead, ref, useNuxtApp, useRoute } from "#imports";
+export function useAnalyticsPageEvent(onChange) {
+  const nuxt = useNuxtApp();
+  const route = useRoute();
+  const head = injectHead();
+  const payload = ref({
+    path: route.fullPath,
+    title: import.meta.client ? document.title : ""
+  });
+  if (import.meta.server)
+    return payload;
+  let lastPayload = { path: "", title: "" };
+  let stopDomWatcher;
+  nuxt.hooks.hook("page:finish", () => {
+    Promise.race([
+      // possibly no head update is needed
+      new Promise((resolve) => setTimeout(resolve, 100)),
+      new Promise((resolve) => {
+        stopDomWatcher = head.hooks.hook("dom:rendered", () => resolve());
+      })
+    ]).finally(() => {
+      stopDomWatcher && stopDomWatcher();
+    }).then(() => {
+      payload.value = {
+        path: route.fullPath,
+        title: document.title
+      };
+      if (lastPayload.path !== payload.value.path || lastPayload.title !== payload.value.title) {
+        onChange && onChange(payload.value);
+        lastPayload = payload.value;
+      }
+    });
+  });
+  return payload;
+}

package/dist/runtime/composables/useScript.d.ts

@@ -0,0 +1,5 @@
+import { type UseScriptInput } from '@unhead/vue';
+import type { UseScriptOptions } from '@unhead/schema';
+export declare function useScript<T>(input: UseScriptInput, options?: Omit<UseScriptOptions<T>, 'trigger'> & {
+    trigger?: UseScriptOptions<T>['trigger'] | 'onNuxtReady';
+}): any;

package/dist/runtime/composables/useScript.mjs

@@ -0,0 +1,57 @@
+import { useScript as _useScript, injectHead } from "@unhead/vue";
+import { onNuxtReady, useNuxtApp } from "#imports";
+export function useScript(input, options) {
+  input = typeof input === "string" ? { src: input } : input;
+  options = options || {};
+  if (options.trigger === "onNuxtReady")
+    options.trigger = onNuxtReady;
+  const nuxtApp = useNuxtApp();
+  const instance = _useScript(input, options);
+  if (import.meta.dev && import.meta.client) {
+    let syncScripts = function() {
+      nuxtApp._scripts[instance.$script.id] = payload;
+      nuxtApp.hooks.callHook("scripts:updated", { scripts: nuxtApp._scripts });
+    };
+    const payload = {
+      key: input.key || input.src,
+      src: input.src,
+      $script: null,
+      events: []
+    };
+    nuxtApp._scripts = nuxtApp._scripts || {};
+    if (!nuxtApp._scripts[instance.$script.id]) {
+      const head = injectHead();
+      head.hooks.hook("script:updated", (ctx) => {
+        if (ctx.script.id !== instance.$script.id)
+          return;
+        payload.events.push({
+          type: "status",
+          status: ctx.script.status,
+          at: Date.now()
+        });
+        payload.$script = instance.$script;
+        syncScripts();
+      });
+      head.hooks.hook("script:instance-fn", (ctx) => {
+        if (ctx.script.id !== instance.$script.id)
+          return;
+        payload.events.push({
+          type: "fn-call",
+          fn: ctx.fn,
+          args: ctx.args,
+          at: Date.now()
+        });
+        syncScripts();
+      });
+      payload.$script = instance.$script;
+      payload.events.push({
+        type: "status",
+        status: "awaitingLoad",
+        trigger: options?.trigger,
+        at: Date.now()
+      });
+      syncScripts();
+    }
+  }
+  return instance;
+}

package/dist/runtime/types.d.ts

@@ -0,0 +1,35 @@
+import type { UseScriptOptions } from '@unhead/schema';
+import type { UseScriptInput } from '@unhead/vue';
+import type { ComputedRef, Ref } from 'vue';
+export type NuxtUseScriptOptions<T = any> = Omit<UseScriptOptions<T>, 'trigger'> & {
+    /**
+     * The trigger to load the script:
+     * - `onNuxtReady` - Load the script when Nuxt is ready.
+     * - `manual` - Load the script manually by calling `$script.load()` or `$script.waitForLoad()`.
+     * - `Promise` - Load the script when the promise resolves.
+     */
+    trigger?: UseScriptOptions<T>['trigger'] | 'onNuxtReady';
+    /**
+     * Should the script be bundled as an asset and loaded from your server. This is useful for improving the
+     * performance by avoiding the extra DNS lookup and reducing the number of requests. It also
+     * improves privacy by not sharing the user's IP address with third-party servers.
+     */
+    assetStrategy?: 'bundle';
+};
+export type NuxtUseScriptInput = UseScriptInput;
+export interface TrackedPage {
+    title?: string;
+    path: string;
+}
+export interface ConsentPromiseOptions {
+    /**
+     * An optional reactive (or promise) reference to the consent state. You can use this to accept the consent for scripts
+     * instead of using the accept() method.
+     */
+    consent?: Promise<boolean | void> | Ref<boolean> | ComputedRef<boolean> | boolean;
+    /**
+     * Should the script be loaded on the `requestIdleCallback` callback. This is useful for non-essential scripts that
+     * have already been consented to be loaded.
+     */
+    loadOnNuxtReady?: boolean;
+}

package/dist/types.d.mts

@@ -0,0 +1,18 @@
+
+import type { ModuleOptions, ModuleHooks } from './module.js'
+
+
+declare module '@nuxt/schema' {
+  interface NuxtConfig { ['scripts']?: Partial<ModuleOptions> }
+  interface NuxtOptions { ['scripts']?: ModuleOptions }
+  interface NuxtHooks extends ModuleHooks {}
+}
+
+declare module 'nuxt/schema' {
+  interface NuxtConfig { ['scripts']?: Partial<ModuleOptions> }
+  interface NuxtOptions { ['scripts']?: ModuleOptions }
+  interface NuxtHooks extends ModuleHooks {}
+}
+
+
+export type { ModuleHooks, ModuleOptions, default } from './module.js'

package/dist/types.d.ts

@@ -0,0 +1,18 @@
+
+import type { ModuleOptions, ModuleHooks } from './module'
+
+
+declare module '@nuxt/schema' {
+  interface NuxtConfig { ['scripts']?: Partial<ModuleOptions> }
+  interface NuxtOptions { ['scripts']?: ModuleOptions }
+  interface NuxtHooks extends ModuleHooks {}
+}
+
+declare module 'nuxt/schema' {
+  interface NuxtConfig { ['scripts']?: Partial<ModuleOptions> }
+  interface NuxtOptions { ['scripts']?: ModuleOptions }
+  interface NuxtHooks extends ModuleHooks {}
+}
+
+
+export type { ModuleHooks, ModuleOptions, default } from './module'

package/package.json

@@ -1,8 +1,88 @@
 {
   "name": "@nuxt/scripts",
-  "version": "0.0.0",
+  "type": "module",
+  "version": "0.1.1",
+  "packageManager": "pnpm@8.15.5",
+  "description": "Next-gen Scripts for Nuxt",
+  "author": {
+    "website": "https://harlanzw.com",
+    "name": "Harlan Wilton",
+    "url": "harlan@harlanzw.com"
+  },
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/nuxt/scripts.git"
+  },
+  "bugs": {
+    "url": "https://github.com/nuxt/scripts/issues"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/types.d.ts",
+      "import": "./dist/module.mjs",
+      "require": "./dist/module.cjs"
+    }
+  },
+  "main": "./dist/module.cjs",
+  "types": "./dist/types.d.ts",
   "files": [
     "dist"
   ],
-  "author": "Daniel Roe <daniel@roe.dev>"
-}
+  "build": {
+    "externals": [
+      "@unhead/vue",
+      "@unhead/schema"
+    ]
+  },
+  "dependencies": {
+    "@nuxt/devtools-kit": "^1.1.1",
+    "@nuxt/devtools-ui-kit": "^1.1.1",
+    "@nuxt/kit": "^3.11.1",
+    "consola": "^3.2.3",
+    "defu": "^6.1.4",
+    "estree-walker": "^3.0.3",
+    "h3": "^1.11.1",
+    "magic-string": "^0.30.8",
+    "ofetch": "^1.3.3",
+    "ohash": "^1.1.3",
+    "pathe": "^1.1.2",
+    "pkg-types": "^1.0.3",
+    "shiki": "^1.2.0",
+    "sirv": "^2.0.4",
+    "ufo": "^1.5.3",
+    "unplugin": "^1.10.0",
+    "unstorage": "^1.10.2"
+  },
+  "devDependencies": {
+    "@antfu/eslint-config": "2.8.3",
+    "@nuxt/devtools-ui-kit": "^1.1.1",
+    "@nuxt/module-builder": "^0.5.5",
+    "@nuxt/test-utils": "3.12.0",
+    "@unhead/schema": "^1.8.20",
+    "acorn-loose": "^8.4.0",
+    "bumpp": "^9.4.0",
+    "eslint": "8.57.0",
+    "nuxt": "^3.11.1",
+    "nuxt-scripts-devtools": "latest",
+    "playwright-core": "^1.42.1",
+    "typescript": "^5.4.3",
+    "vitest": "^1.4.0"
+  },
+  "resolutions": {
+    "@nuxt/scripts": "workspace:*"
+  },
+  "scripts": {
+    "build": "pnpm prepack",
+    "client:build": "nuxi generate client",
+    "client:dev": "nuxi dev client --port 3300",
+    "dev": "nuxi dev playground",
+    "dev:prepare": "nuxt-module-build build --stub && nuxt-module-build prepare && nuxi prepare playground",
+    "typecheck": "pnpm dlx vue-tsc --noEmit",
+    "release": "pnpm build && bumpp && pnpm -r publish --no-git-checks",
+    "lint": "eslint .",
+    "lint:fix": "eslint . --fix",
+    "test": "true",
+    "test:types": "true"
+  }
+}