@nuxt/scripts 2.0.0-beta.6 → 2.0.0-beta.8

package/dist/runtime/registry/tawk-to.d.ts

@@ -0,0 +1,126 @@
+import type { Ref } from 'vue';
+import type { RegistryScriptInput, UseScriptContext } from '#nuxt-scripts/types';
+import { TawkToOptions } from './schemas.js';
+export { TawkToOptions };
+export type TawkToInput = RegistryScriptInput<typeof TawkToOptions, false, false>;
+export type TawkToStatus = 'online' | 'away' | 'offline';
+export type TawkToWindowType = 'inline' | 'embed';
+export type TawkToWidgetPosition = 'br' | 'bl' | 'cr' | 'cl' | 'tr' | 'tl';
+export interface TawkToVisitor {
+    name?: string;
+    email?: string;
+    /** Visitor phone number in E.164 format (e.g. `+15551234567`). */
+    phone?: string;
+    /** HMAC-SHA256 signature for Tawk's Secure Mode, generated server-side by the consumer. */
+    hash?: string;
+}
+/**
+ * The `window.Tawk_API` surface, as exposed through `proxy`. `proxy` is
+ * fire-and-forget: unhead's script proxy queues/replays calls but always
+ * discards their return value, even once the script is fully loaded (and it
+ * has no `set` trap, so plain property assignment through it goes nowhere).
+ * That means only void-returning actions belong here - real getters and the
+ * `visitor` setter live on `useScriptTawkTo()`'s own return value instead
+ * (see `TawkToEvents`), backed directly by `window.Tawk_API`.
+ * @see https://developer.tawk.to/jsapi/
+ */
+export interface TawkToApi {
+    /** Starts the chat. Pass `{ showWidget: true }` to also show the widget. */
+    start: (options?: {
+        showWidget?: boolean;
+    }) => void;
+    shutdown: () => void;
+    maximize: () => void;
+    minimize: () => void;
+    toggle: () => void;
+    popup: () => void;
+    showWidget: () => void;
+    hideWidget: () => void;
+    toggleVisibility: () => void;
+    endChat: () => void;
+    getWindowType: () => TawkToWindowType;
+    getStatus: () => TawkToStatus;
+    isChatMaximized: () => boolean;
+    isChatMinimized: () => boolean;
+    isChatHidden: () => boolean;
+    isChatOngoing: () => boolean;
+    isVisitorEngaged: () => boolean;
+    /** Set by Tawk once the widget has finished loading. The embed writes a boolean (`!0`), not a number. */
+    onLoaded?: boolean;
+    /** Set by Tawk before the widget begins loading. */
+    onBeforeLoaded?: boolean;
+    widgetPosition: () => TawkToWidgetPosition;
+    visitor?: TawkToVisitor;
+    setAttributes: (attributes: Record<string, string>, callback?: (error: Error | null) => void) => void;
+    addEvent: (event: string, metadata?: Record<string, unknown>, callback?: (error: Error | null) => void) => void;
+    addTags: (tags: string[], callback?: (error: Error | null) => void) => void;
+    removeTags: (tags: string[], callback?: (error: Error | null) => void) => void;
+    switchWidget: (data: {
+        propertyId: string;
+        widgetId: string;
+    }, callback?: (error: Error | null) => void) => void;
+}
+declare global {
+    interface Window {
+        Tawk_API?: TawkToApi;
+        Tawk_LoadStart?: Date;
+    }
+}
+/**
+ * The subset of `TawkToApi` that `proxy` actually exposes: the getters, the
+ * `visitor` setter and the `onLoaded`/`onBeforeLoaded` flags are omitted since
+ * none of them work through the fire-and-forget proxy (see `TawkToApi`'s doc
+ * comment). They're still real members of the underlying `window.Tawk_API`
+ * object, just not reachable via `proxy`.
+ */
+export type TawkToProxyApi = Omit<TawkToApi, 'getWindowType' | 'getStatus' | 'isChatMaximized' | 'isChatMinimized' | 'isChatHidden' | 'isChatOngoing' | 'isVisitorEngaged' | 'widgetPosition' | 'visitor' | 'onLoaded' | 'onBeforeLoaded'>;
+/**
+ * Reactive state and typed event listeners bridged from the `window`
+ * `CustomEvent`s Tawk's embed script dispatches (`tawkLoad`, `tawkStatusChange`, etc).
+ * These aren't part of the documented `Tawk_API.onXxx = fn` callback-property API -
+ * they're a separate, verified-in-the-browser signal the embed script also fires.
+ */
+export interface TawkToEvents {
+    isHidden: Readonly<Ref<boolean>>;
+    isMinimized: Readonly<Ref<boolean>>;
+    isMaximized: Readonly<Ref<boolean>>;
+    /** The operator status Tawk reports (`getStatus()`) — not to be confused with `status`, the script's own load state. */
+    chatStatus: Readonly<Ref<TawkToStatus>>;
+    unreadCount: Readonly<Ref<number>>;
+    getWindowType: () => TawkToWindowType | undefined;
+    getStatus: () => TawkToStatus | undefined;
+    isChatMaximized: () => boolean;
+    isChatMinimized: () => boolean;
+    isChatHidden: () => boolean;
+    isChatOngoing: () => boolean;
+    isVisitorEngaged: () => boolean;
+    widgetPosition: () => TawkToWidgetPosition | undefined;
+    /**
+     * Sets `Tawk_API.visitor` directly - assigning through `proxy.visitor` is a no-op
+     * (no `set` trap). Pre-insertion only: Tawk honors `Tawk_API.visitor` until the
+     * embed script is requested, so a call after that warns and does nothing - use
+     * `window.Tawk_API.setAttributes()` for post-load identity changes.
+     */
+    setVisitor: (data: TawkToVisitor) => void;
+    onLoad: (cb: () => void) => () => void;
+    onBeforeLoad: (cb: () => void) => () => void;
+    onStatusChange: (cb: (status: TawkToStatus) => void) => () => void;
+    onChatMaximized: (cb: () => void) => () => void;
+    onChatMinimized: (cb: () => void) => () => void;
+    onChatHidden: (cb: () => void) => () => void;
+    onChatStarted: (cb: () => void) => () => void;
+    onChatEnded: (cb: () => void) => () => void;
+    onPrechatSubmit: (cb: (data: Record<string, unknown>) => void) => () => void;
+    onOfflineSubmit: (cb: (data: Record<string, unknown>) => void) => () => void;
+    onChatMessageVisitor: (cb: (message: string) => void) => () => void;
+    onChatMessageAgent: (cb: (message: string) => void) => () => void;
+    onChatMessageSystem: (cb: (message: string) => void) => () => void;
+    onAgentJoinChat: (cb: (data: Record<string, unknown>) => void) => () => void;
+    onAgentLeaveChat: (cb: (data: Record<string, unknown>) => void) => () => void;
+    onChatSatisfaction: (cb: (satisfaction: number) => void) => () => void;
+    onVisitorNameChanged: (cb: (visitorName: string) => void) => () => void;
+    onFileUpload: (cb: (link: string) => void) => () => void;
+    onTagsUpdated: (cb: (data: Record<string, unknown>) => void) => () => void;
+    onUnreadCountChanged: (cb: (count: number) => void) => () => void;
+}
+export declare function useScriptTawkTo<T extends TawkToProxyApi>(_options?: TawkToInput): UseScriptContext<T> & TawkToEvents;

package/dist/runtime/registry/tawk-to.js

@@ -0,0 +1,147 @@
+import { joinURL } from "ufo";
+import { ref } from "vue";
+import { useRegistryScript } from "../utils.js";
+import { TawkToOptions } from "./schemas.js";
+export { TawkToOptions };
+const isHidden = ref(false);
+const isMinimized = ref(false);
+const isMaximized = ref(false);
+const chatStatus = ref("offline");
+const unreadCount = ref(0);
+function listen(event, cb) {
+  if (import.meta.server)
+    return () => {
+    };
+  const handler = (e) => cb(e.detail);
+  window.addEventListener(event, handler);
+  return () => window.removeEventListener(event, handler);
+}
+let stateBridged = false;
+function ensureStateBridge() {
+  if (stateBridged)
+    return;
+  stateBridged = true;
+  listen("tawkLoad", () => {
+    isHidden.value = !!window.Tawk_API?.isChatHidden?.();
+    isMinimized.value = !!window.Tawk_API?.isChatMinimized?.();
+    isMaximized.value = !!window.Tawk_API?.isChatMaximized?.();
+    chatStatus.value = window.Tawk_API?.getStatus?.() ?? "offline";
+  });
+  listen("tawkStatusChange", (detail) => {
+    chatStatus.value = detail;
+  });
+  listen("tawkChatHidden", () => {
+    isHidden.value = true;
+  });
+  listen("tawkChatMinimized", () => {
+    isMinimized.value = true;
+    isMaximized.value = false;
+  });
+  listen("tawkChatMaximized", () => {
+    isMaximized.value = true;
+    isMinimized.value = false;
+  });
+  listen("tawkUnreadCountChanged", (detail) => {
+    unreadCount.value = detail;
+  });
+}
+function resyncHiddenState() {
+  if (import.meta.server)
+    return;
+  isHidden.value = !!window.Tawk_API?.isChatHidden?.();
+}
+const visibilityCommands = /* @__PURE__ */ new Set(["hideWidget", "showWidget", "toggleVisibility"]);
+const TAWK_PROXY_DECORATED = Symbol("nuxt-scripts.tawk-proxy-decorated");
+export function useScriptTawkTo(_options) {
+  const instance = useRegistryScript("tawkTo", (options) => ({
+    scriptInput: {
+      src: joinURL("https://embed.tawk.to", options.propertyId, options.widgetId),
+      async: true,
+      crossorigin: "anonymous"
+    },
+    schema: import.meta.dev ? TawkToOptions : void 0,
+    scriptOptions: {
+      resolve({ waitFor }) {
+        if (window.Tawk_API?.onLoaded)
+          return window.Tawk_API;
+        return waitFor((resolve, reject) => {
+          const stop = listen("tawkLoad", () => {
+            stop();
+            if (window.Tawk_API)
+              resolve(window.Tawk_API);
+            else
+              reject(new Error("[nuxt-scripts] Tawk.to reported ready without exposing window.Tawk_API"));
+          });
+          return stop;
+        });
+      }
+    },
+    clientInit: import.meta.server ? void 0 : () => {
+      window.Tawk_API = window.Tawk_API || {};
+      window.Tawk_LoadStart = /* @__PURE__ */ new Date();
+    }
+  }), _options);
+  if (!import.meta.server) {
+    ensureStateBridge();
+    const shared = instance.script || instance;
+    if (shared.proxy && !shared[TAWK_PROXY_DECORATED]) {
+      shared.proxy = new Proxy(shared.proxy, {
+        get(target, prop, receiver) {
+          const value = Reflect.get(target, prop, receiver);
+          if (!(typeof prop === "string" && visibilityCommands.has(prop)) || typeof value !== "function")
+            return value;
+          return (...args) => {
+            ;
+            value(...args);
+            resyncHiddenState();
+          };
+        }
+      });
+      Object.defineProperty(shared, TAWK_PROXY_DECORATED, { value: true });
+    }
+  }
+  instance.isHidden = isHidden;
+  instance.isMinimized = isMinimized;
+  instance.isMaximized = isMaximized;
+  instance.chatStatus = chatStatus;
+  instance.unreadCount = unreadCount;
+  instance.onLoad = (cb) => listen("tawkLoad", cb);
+  instance.onBeforeLoad = (cb) => listen("tawkBeforeLoad", cb);
+  instance.onStatusChange = (cb) => listen("tawkStatusChange", cb);
+  instance.onChatMaximized = (cb) => listen("tawkChatMaximized", cb);
+  instance.onChatMinimized = (cb) => listen("tawkChatMinimized", cb);
+  instance.onChatHidden = (cb) => listen("tawkChatHidden", cb);
+  instance.onChatStarted = (cb) => listen("tawkChatStarted", cb);
+  instance.onChatEnded = (cb) => listen("tawkChatEnded", cb);
+  instance.onPrechatSubmit = (cb) => listen("tawkPrechatSubmit", cb);
+  instance.onOfflineSubmit = (cb) => listen("tawkOfflineSubmit", cb);
+  instance.onChatMessageVisitor = (cb) => listen("tawkChatMessageVisitor", cb);
+  instance.onChatMessageAgent = (cb) => listen("tawkChatMessageAgent", cb);
+  instance.onChatMessageSystem = (cb) => listen("tawkChatMessageSystem", cb);
+  instance.onAgentJoinChat = (cb) => listen("tawkAgentJoinChat", cb);
+  instance.onAgentLeaveChat = (cb) => listen("tawkAgentLeaveChat", cb);
+  instance.onChatSatisfaction = (cb) => listen("tawkChatSatisfaction", cb);
+  instance.onVisitorNameChanged = (cb) => listen("tawkVisitorNameChanged", cb);
+  instance.onFileUpload = (cb) => listen("tawkFileUpload", cb);
+  instance.onTagsUpdated = (cb) => listen("tawkTagsUpdated", cb);
+  instance.onUnreadCountChanged = (cb) => listen("tawkUnreadCountChanged", cb);
+  instance.getWindowType = () => import.meta.server ? void 0 : window.Tawk_API?.getWindowType?.();
+  instance.getStatus = () => import.meta.server ? void 0 : window.Tawk_API?.getStatus?.();
+  instance.isChatMaximized = () => !import.meta.server && !!window.Tawk_API?.isChatMaximized?.();
+  instance.isChatMinimized = () => !import.meta.server && !!window.Tawk_API?.isChatMinimized?.();
+  instance.isChatHidden = () => !import.meta.server && !!window.Tawk_API?.isChatHidden?.();
+  instance.isChatOngoing = () => !import.meta.server && !!window.Tawk_API?.isChatOngoing?.();
+  instance.isVisitorEngaged = () => !import.meta.server && !!window.Tawk_API?.isVisitorEngaged?.();
+  instance.widgetPosition = () => import.meta.server ? void 0 : window.Tawk_API?.widgetPosition?.();
+  instance.setVisitor = (data) => {
+    if (import.meta.server)
+      return;
+    window.Tawk_API = window.Tawk_API || {};
+    if (instance.status.value !== "awaitingLoad" || window.Tawk_API.onLoaded) {
+      console.warn("[nuxt-scripts] Tawk.to: setVisitor() only works before the widget script is inserted. Tawk drops visitor data written after that - set it before the widget loads, or use window.Tawk_API.setAttributes({ name, email, phone, hash }) afterwards.");
+      return;
+    }
+    window.Tawk_API.visitor = data;
+  };
+  return instance;
+}

package/dist/runtime/types.d.ts

@@ -34,12 +34,14 @@ import type { NpmInput } from './registry/npm.js';
 import type { PayPalInput } from './registry/paypal.js';
 import type { PlausibleAnalyticsInput } from './registry/plausible-analytics.js';
 import type { PostHogInput } from './registry/posthog.js';
+import type { PulseAnalyticsInput } from './registry/pulse-analytics.js';
 import type { RedditPixelInput } from './registry/reddit-pixel.js';
 import type { RybbitAnalyticsInput } from './registry/rybbit-analytics.js';
 import type { SegmentInput } from './registry/segment.js';
 import type { SnapTrPixelInput } from './registry/snapchat-pixel.js';
 import type { SpeedCurveInput } from './registry/speedcurve.js';
 import type { StripeInput } from './registry/stripe.js';
+import type { TawkToInput } from './registry/tawk-to.js';
 import type { TikTokPixelInput } from './registry/tiktok-pixel.js';
 import type { UmamiAnalyticsInput } from './registry/umami-analytics.js';
 import type { UsercentricsInput } from './registry/usercentrics.js';
@@ -51,6 +53,7 @@ import type { YouTubePlayerInput } from './registry/youtube-player.js';
 import type { ProxyPrivacyInput } from './server/utils/privacy.js';
 export type { Cluster, ClusterStats, MarkerClustererContext, MarkerClustererInstance, MarkerClustererOptions } from './components/GoogleMaps/types.js';
 export { MARKER_CLUSTERER_INJECTION_KEY } from './components/GoogleMaps/types.js';
+export type { ScriptMapLibreAttributionControlProps, ScriptMapLibreFullscreenControlEmits, ScriptMapLibreFullscreenControlProps, ScriptMapLibreGeoJsonEmits, ScriptMapLibreGeoJsonLayer, ScriptMapLibreGeoJsonProps, ScriptMapLibreGeoJsonResource, ScriptMapLibreGeolocateControlEmits, ScriptMapLibreGeolocateControlProps, ScriptMapLibreMapEmits, ScriptMapLibreMapExpose, ScriptMapLibreMapProps, ScriptMapLibreMapSlots, ScriptMapLibreMarkerEmits, ScriptMapLibreMarkerProps, ScriptMapLibreNavigationControlProps, ScriptMapLibrePopupEmits, ScriptMapLibrePopupProps, ScriptMapLibreScaleControlProps, } from './components/MapLibre/types.js';
 export type WarmupStrategy = false | 'preload' | 'preconnect' | 'dns-prefetch';
 /**
  * GCMv2 consent category value.
@@ -265,6 +268,7 @@ export interface ScriptRegistry {
     linkedinInsight?: LinkedInInsightInput;
     paypal?: PayPalInput;
     posthog?: PostHogInput;
+    pulseAnalytics?: PulseAnalyticsInput;
     matomoAnalytics?: MatomoAnalyticsInput;
     mixpanelAnalytics?: MixpanelAnalyticsInput;
     rybbitAnalytics?: RybbitAnalyticsInput;
@@ -272,6 +276,7 @@ export interface ScriptRegistry {
     segment?: SegmentInput;
     speedcurve?: SpeedCurveInput;
     stripe?: StripeInput;
+    tawkTo?: TawkToInput;
     tiktokPixel?: TikTokPixelInput;
     xEmbed?: XEmbedInput;
     xPixel?: XPixelInput;
@@ -289,7 +294,7 @@ export interface ScriptRegistry {
  * Built-in registry script keys — not affected by module augmentation.
  * Use this to type-check records that must enumerate all built-in scripts (logos, meta, etc.).
  */
-export type BuiltInRegistryScriptKey = 'ahrefsAnalytics' | 'bingUet' | 'blueskyEmbed' | 'calendly' | 'carbonAds' | 'crisp' | 'clarity' | 'cloudflareWebAnalytics' | 'databuddyAnalytics' | 'deskcrew' | 'metaPixel' | 'fathomAnalytics' | 'instagramEmbed' | 'plausibleAnalytics' | 'googleAdsense' | 'googleAnalytics' | 'googleMaps' | 'leaflet' | 'maplibre' | 'googleRecaptcha' | 'googleSignIn' | 'lemonSqueezy' | 'googleTagManager' | 'hotjar' | 'intercom' | 'linkedinInsight' | 'paypal' | 'posthog' | 'matomoAnalytics' | 'mixpanelAnalytics' | 'rybbitAnalytics' | 'redditPixel' | 'segment' | 'stripe' | 'tiktokPixel' | 'xEmbed' | 'xPixel' | 'snapchatPixel' | 'speedcurve' | 'youtubePlayer' | 'vercelAnalytics' | 'vimeoPlayer' | 'umamiAnalytics' | 'usercentrics' | 'gravatar' | 'npm';
+export type BuiltInRegistryScriptKey = 'ahrefsAnalytics' | 'bingUet' | 'blueskyEmbed' | 'calendly' | 'carbonAds' | 'crisp' | 'clarity' | 'cloudflareWebAnalytics' | 'databuddyAnalytics' | 'deskcrew' | 'metaPixel' | 'fathomAnalytics' | 'instagramEmbed' | 'plausibleAnalytics' | 'googleAdsense' | 'googleAnalytics' | 'googleMaps' | 'leaflet' | 'maplibre' | 'googleRecaptcha' | 'googleSignIn' | 'lemonSqueezy' | 'googleTagManager' | 'hotjar' | 'intercom' | 'linkedinInsight' | 'paypal' | 'posthog' | 'pulseAnalytics' | 'matomoAnalytics' | 'mixpanelAnalytics' | 'rybbitAnalytics' | 'redditPixel' | 'segment' | 'stripe' | 'tawkTo' | 'tiktokPixel' | 'xEmbed' | 'xPixel' | 'snapchatPixel' | 'speedcurve' | 'youtubePlayer' | 'vercelAnalytics' | 'vimeoPlayer' | 'umamiAnalytics' | 'usercentrics' | 'gravatar' | 'npm';
 /**
  * Union of all explicit registry script keys (excludes npm pattern).
  * Includes both built-in and augmented keys.

package/dist/stats.mjs

@@ -34,6 +34,10 @@ const scriptMeta = {
     urls: ["https://app.rybbit.io/api/script.js"],
     trackedData: ["page-views", "events"]
   },
+  pulseAnalytics: {
+    urls: ["https://js.ciphera.net/script.js"],
+    trackedData: ["page-views", "events", "conversions", "scrolls"]
+  },
   databuddyAnalytics: {
     urls: ["https://cdn.databuddy.cc/databuddy.js"],
     trackedData: ["page-views", "events"]
@@ -129,6 +133,11 @@ const scriptMeta = {
     trackedData: ["user-identity", "events", "errors"],
     testId: "pub_deskcrewdemo"
   },
+  tawkTo: {
+    urls: ["https://embed.tawk.to/68496650ddf9cd19094b4530/1itfbfagd"],
+    trackedData: ["user-identity", "events"],
+    testId: "68496650ddf9cd19094b4530"
+  },
   crisp: {
     urls: ["https://client.crisp.chat/l.js"],
     trackedData: ["user-identity", "events"],
@@ -691,6 +700,77 @@ const rybbitAnalytics = {
 		}
 	]
 };
+const pulseAnalytics = {
+	totalTransferKb: 3.5,
+	totalDecodedKb: 6.4,
+	loadTimeMs: 510,
+	collectsWebVitals: false,
+	apis: {
+		cookies: false,
+		localStorage: true,
+		sessionStorage: true,
+		indexedDB: false,
+		canvas: false,
+		webgl: false,
+		audioContext: false,
+		userAgent: false,
+		doNotTrack: true,
+		hardwareConcurrency: false,
+		deviceMemory: false,
+		plugins: true,
+		languages: true,
+		screen: true,
+		timezone: false,
+		platform: true,
+		vendor: false,
+		connection: false,
+		maxTouchPoints: true,
+		devicePixelRatio: false,
+		mediaDevices: false,
+		getBattery: false,
+		referrer: true,
+		windowName: false,
+		rtcPeerConnection: false,
+		geolocation: false,
+		serviceWorker: false,
+		cacheApi: false,
+		sendBeacon: true,
+		fetch: true,
+		xhr: false,
+		websocket: false,
+		mutationObserver: true,
+		performanceObserver: false,
+		intersectionObserver: false
+	},
+	cookies: [
+	],
+	network: {
+		requestCount: 1,
+		domains: [
+			"js.ciphera.net"
+		],
+		outboundBytes: 0,
+		inboundBytes: 3586,
+		injectedElements: [
+		]
+	},
+	performance: {
+		taskDurationMs: 31,
+		scriptDurationMs: 0,
+		heapDeltaKb: 726
+	},
+	scripts: [
+		{
+			url: "https://js.ciphera.net/script.js",
+			transferKb: 3.5,
+			decodedKb: 6.4,
+			encoding: "zstd",
+			durationMs: 510,
+			initiatorType: "script",
+			protocol: "unknown"
+		}
+	]
+};
 const databuddyAnalytics = {
 	totalTransferKb: 10.8,
 	totalDecodedKb: 29.4,
@@ -3500,6 +3580,7 @@ const scriptSizes = {
 	fathomAnalytics: fathomAnalytics,
 	matomoAnalytics: matomoAnalytics,
 	rybbitAnalytics: rybbitAnalytics,
+	pulseAnalytics: pulseAnalytics,
 	databuddyAnalytics: databuddyAnalytics,
 	mixpanelAnalytics: mixpanelAnalytics,
 	segment: segment,