@ciphera-net/pulse-nuxt 1.0.0

package/LICENSE

@@ -0,0 +1,203 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+

package/README.md

@@ -0,0 +1,110 @@
+# Pulse Analytics for Nuxt
+
+Privacy-first analytics for a Nuxt site, in one module. No cookies, no personal
+data, and the script it adds to your pages is under 3 KB.
+
+[Pulse Analytics](https://pulse.ciphera.net) is built by [Ciphera](https://ciphera.net), a
+company in Belgium, and hosted in Europe.
+
+## Install
+
+```bash
+npx nuxi module add @ciphera-net/pulse-nuxt
+```
+
+Or by hand:
+
+```bash
+npm install -D @ciphera-net/pulse-nuxt
+```
+
+```ts
+// nuxt.config.ts
+export default defineNuxtConfig({
+  modules: ["@ciphera-net/pulse-nuxt"],
+  pulse: { domain: "example.com" },
+})
+```
+
+That is the whole setup. `domain` is the hostname your site is registered under
+in Pulse — if a site-config module (`@nuxtjs/sitemap`, `@nuxtjs/robots`,
+`@nuxtjs/seo`) already gives you a `site.url`, you can leave it out and the
+module reads the hostname from there.
+
+You need a Pulse Analytics account with a site registered for the same domain.
+The free plan is enough to start.
+
+## Options
+
+| Option | Default | What it does |
+|---|---|---|
+| `domain` | from `site.url` | The domain your site is registered under in Pulse Analytics. Pass this when `site.url` is not the domain you track, for example on a preview deployment. |
+| `apiUrl` | — | Route events through your own proxy origin. A bare origin (`https://example.com`), not a full URL: the tracker appends its own path. |
+| `trackScroll` | `true` | Record scroll depth. |
+| `trackOutbound` | `true` | Record outbound link clicks as `outbound_link` events. |
+| `trackDownloads` | `true` | Record file download clicks as `file_download` events. |
+| `companion` | `false` | Also record clicks, copies and form submits. A second, separate script — see below. `true` records all three; an object turns individual ones off. |
+| `injectInDev` | `false` | Inject during `nuxt dev` too. Off by default — see below. |
+
+```ts
+pulse: {
+  domain: "example.com",
+  companion: { copy: false },
+  trackScroll: false,
+}
+```
+
+## Three things worth knowing
+
+**It does not run in `nuxt dev`.** The tracker has no localhost guard, so a dev
+server would send real pageviews at your production dashboard. The module prints
+a line saying it stayed out. Set `injectInDev: true` if you actually want it.
+
+**The interaction capture is a second request on purpose.** The core script's
+size is a published claim, and nothing gets folded into it to make a feature
+look free. `companion: true` costs you a second, separate file.
+
+**View-source shows the tag itself.** Unlike the Astro and Framer integrations,
+this module adds a real `<script src>` to `app.head`, so the tag Nuxt renders is
+byte-for-byte the one you would paste into a layout by hand, and no JavaScript
+of ours reaches your bundle. It works with a strict Content-Security-Policy that
+forbids inline script.
+
+## Already using `@nuxt/scripts`?
+
+Then you may not need this module. Pulse is a first-party entry in the
+[Nuxt Scripts registry](https://scripts.nuxt.com) as `useScriptPulseAnalytics`,
+which gives you loading triggers, consent gating and a typed `track()` you can
+call from a component. The option names here (`domain`, `apiUrl`, `trackScroll`,
+`trackOutbound`, `trackDownloads`) are deliberately the same, so moving either
+way is a copy and paste.
+
+Take this module when you want the tag and nothing else; take `@nuxt/scripts`
+when you want the tag *and* a way to fire events from your components. Do not
+install both — they would each add a tag, and the pageviews would double.
+
+## What Pulse Analytics measures
+
+Pageviews, referrers, countries, devices, time on page and scroll depth, plus
+goals, funnels and campaigns. It sets no cookies and stores no personal data.
+Visitors whose browser sends Do Not Track or Global Privacy Control are not
+counted at all — so if you test in Brave or Firefox and see nothing, that is the
+tracker behaving correctly. Safari is the easiest browser to verify an install in.
+
+## Compatibility
+
+Nuxt 3 and Nuxt 4. The range is measured, not asserted: `npm run verify` builds
+a real Nuxt site on each major and reads the tag out of the emitted HTML.
+Nuxt 2 is refused with an error — its head is Vue Meta and a different shape
+entirely.
+
+## Licence
+
+Copyright 2026 Ciphera BV. Licensed under the Apache License, Version 2.0 —
+the `LICENSE` file is the licence text verbatim, so the copyright line lives
+here rather than inside it.
+
+This package has **zero runtime dependencies**, asserted in CI.
+
+Nuxt is a trademark of its owners; this is an independent module and is not
+affiliated with or endorsed by the Nuxt project.

package/dist/module.d.ts

@@ -0,0 +1,42 @@
+import type { Nuxt } from "@nuxt/schema";
+import { type ModuleOptions } from "./pulse.js";
+export type { ModuleOptions, CompanionOptions, ScriptDescriptor } from "./pulse.js";
+export { SCRIPT_URL, COMPANION_URL, buildScripts, normalizeDomain, isValidDomain, hostnameFromSite, resolveCompanion, resolveDomain, } from "./pulse.js";
+/**
+ * Pulse Analytics — privacy-first web analytics for Nuxt.
+ *
+ *   export default defineNuxtConfig({
+ *     modules: ["@ciphera-net/pulse-nuxt"],
+ *     pulse: { domain: "example.com" },
+ *   })
+ *
+ * 🔑 This is a plain module function rather than a `defineNuxtModule()` call,
+ * and that is a deliberate, measured choice — see RELEASING.md § "Why there is
+ * no @nuxt/kit dependency". The short version: everything this module does is
+ * push two objects into `nuxt.options.app.head.script`, `defineNuxtModule` is
+ * sugar around that, and taking `@nuxt/kit` costs a runtime dependency plus a
+ * version range that peers have already got wrong. The one thing the sugar
+ * would buy — the compatibility gate — is done explicitly below, because Nuxt
+ * does NOT read `.meta.compatibility` off a bare function module. That was
+ * proven with a control: a module declaring `nuxt: "^99.0.0"` built clean
+ * against Nuxt 4.5.2, silently.
+ */
+declare function pulseModule(inlineOptions: ModuleOptions | undefined, nuxt: Nuxt): void;
+declare namespace pulseModule {
+    var meta: {
+        name: string;
+        configKey: string;
+        compatibility: {
+            nuxt: string;
+        };
+    };
+}
+export default pulseModule;
+declare module "@nuxt/schema" {
+    interface NuxtConfig {
+        pulse?: ModuleOptions;
+    }
+    interface NuxtOptions {
+        pulse?: ModuleOptions;
+    }
+}

package/dist/module.js

@@ -0,0 +1,98 @@
+import { buildScripts, resolveDomain } from "./pulse.js";
+export { SCRIPT_URL, COMPANION_URL, buildScripts, normalizeDomain, isValidDomain, hostnameFromSite, resolveCompanion, resolveDomain, } from "./pulse.js";
+const MODULE_NAME = "@ciphera-net/pulse-nuxt";
+const CONFIG_KEY = "pulse";
+/** The oldest Nuxt whose module contract and `app.head` this module is built
+ *  for. Nuxt 2's head is Vue Meta with a different shape entirely, so this is
+ *  a real boundary, not a courtesy. */
+const MIN_MAJOR = 3;
+/**
+ * Pulse Analytics — privacy-first web analytics for Nuxt.
+ *
+ *   export default defineNuxtConfig({
+ *     modules: ["@ciphera-net/pulse-nuxt"],
+ *     pulse: { domain: "example.com" },
+ *   })
+ *
+ * 🔑 This is a plain module function rather than a `defineNuxtModule()` call,
+ * and that is a deliberate, measured choice — see RELEASING.md § "Why there is
+ * no @nuxt/kit dependency". The short version: everything this module does is
+ * push two objects into `nuxt.options.app.head.script`, `defineNuxtModule` is
+ * sugar around that, and taking `@nuxt/kit` costs a runtime dependency plus a
+ * version range that peers have already got wrong. The one thing the sugar
+ * would buy — the compatibility gate — is done explicitly below, because Nuxt
+ * does NOT read `.meta.compatibility` off a bare function module. That was
+ * proven with a control: a module declaring `nuxt: "^99.0.0"` built clean
+ * against Nuxt 4.5.2, silently.
+ */
+function pulseModule(inlineOptions, nuxt) {
+    const options = {
+        ...(nuxt.options[CONFIG_KEY] ?? {}),
+        ...(inlineOptions ?? {}),
+    };
+    const major = nuxtMajor(nuxt);
+    if (major !== null && major < MIN_MAJOR) {
+        throw new Error(`[pulse] ${MODULE_NAME} requires Nuxt ${MIN_MAJOR} or newer; this project is running Nuxt ${major}.`);
+    }
+    // The tracker has no localhost guard, so a dev server would send real
+    // pageviews at the production dashboard. Opt in deliberately — and say so
+    // either way, because an analytics module that is quietly absent is the
+    // worst of the three outcomes.
+    if (nuxt.options.dev && !options.injectInDev) {
+        log("info", "not injected in dev (set `injectInDev: true` to override)");
+        return;
+    }
+    // `site.url` is not a Nuxt core option. `nuxt-site-config` adds it, and
+    // @nuxtjs/sitemap, @nuxtjs/robots and @nuxtjs/seo all install that — so it
+    // is there often enough to be worth reading and never there reliably enough
+    // to depend on.
+    const siteUrl = nuxt.options.site?.url;
+    // Throws on an explicitly supplied domain that cannot be a hostname. A typo
+    // there is a silent no-data install, which is worth a build error.
+    const { domain, source } = resolveDomain(options, siteUrl);
+    const head = (nuxt.options.app.head ??= {});
+    const scripts = (head.script ??= []);
+    scripts.push(...buildScripts(domain, options));
+    if (source === "browser") {
+        log("warn", "no `pulse.domain` and no `site.url` — the tag will auto-detect the browser's hostname. Set `pulse: { domain: \"…\" }` if this site is served on more than one domain.");
+    }
+    else {
+        const from = source === "option" ? "the `domain` option" : "`site.url`";
+        const extra = options.companion ? ", with interaction capture" : "";
+        log("info", `tracking ${domain} (from ${from})${extra}`);
+    }
+}
+/** Nuxt's major version, or null when it cannot be read.
+ *
+ *  `nuxt._version` is the full string (`"4.5.2"`, measured) and
+ *  `nuxt.options._majorVersion` is the number. Both are private fields, which
+ *  is why this returns null rather than guessing when neither is present: a
+ *  module that refuses to load because it could not read a private field would
+ *  be worse than one that loads and works. */
+function nuxtMajor(nuxt) {
+    const full = nuxt._version;
+    if (typeof full === "string") {
+        const major = Number.parseInt(full.split(".")[0] ?? "", 10);
+        if (Number.isFinite(major))
+            return major;
+    }
+    const fromOptions = nuxt.options._majorVersion;
+    return typeof fromOptions === "number" ? fromOptions : null;
+}
+/** Nuxt's own logger lives in `@nuxt/kit`, which this module deliberately does
+ *  not take, so these go to the console. They are the only output the module
+ *  produces, and saying nothing at all would make "did it inject?" an
+ *  unanswerable question. */
+function log(level, message) {
+    const line = `[${CONFIG_KEY}] ${message}`;
+    if (level === "warn")
+        console.warn(line);
+    else
+        console.info(line);
+}
+pulseModule.meta = {
+    name: MODULE_NAME,
+    configKey: CONFIG_KEY,
+    compatibility: { nuxt: ">=3.0.0" },
+};
+export default pulseModule;

package/dist/module.json

@@ -0,0 +1,9 @@
+{
+  "name": "@ciphera-net/pulse-nuxt",
+  "version": "1.0.0",
+  "configKey": "pulse",
+  "compatibility": {
+    "nuxt": ">=3.0.0"
+  },
+  "docs": "https://github.com/ciphera-net/pulse-nuxt#readme"
+}

package/dist/pulse.d.ts

@@ -0,0 +1,79 @@
+export declare const SCRIPT_URL = "https://js.ciphera.net/script.js";
+export declare const COMPANION_URL = "https://js.ciphera.net/script.interactions.js";
+/** Lower-case, drop a scheme, path, port and trailing dot. Keeps `www.` — the
+ *  Pulse site may be registered either way and the user can override it. */
+export declare function normalizeDomain(input: string): string;
+export declare function isValidDomain(domain: string): boolean;
+/** The hostname of a site URL, or null when it is unset or does not parse.
+ *  Nuxt core has no `site` option; `nuxt-site-config` (which `@nuxtjs/sitemap`,
+ *  `@nuxtjs/robots` and `@nuxtjs/seo` all install) adds `site.url`, and this is
+ *  how we read it when it happens to be there. */
+export declare function hostnameFromSite(site: string | URL | undefined | null): string | null;
+/** Which interactions the companion script records. Every one defaults to on;
+ *  the tracker reads them as `data-no-*` presence flags. */
+export interface CompanionOptions {
+    /** Record clicks on buttons and links as `click` events. */
+    clicks?: boolean;
+    /** Record text copies as `copy` events. */
+    copy?: boolean;
+    /** Record form submits as `form_submit` events. */
+    forms?: boolean;
+}
+export interface ModuleOptions {
+    /** The domain the site is registered under in Pulse. Defaults to the
+     *  hostname of `site.url` when a site-config module provides one. With
+     *  neither, the tag carries no `data-domain` and the tracker falls back to
+     *  the browser's own hostname — correct for a single-domain site. */
+    domain?: string;
+    /** Route events through your own proxy origin. A bare origin
+     *  (`https://example.com`), not a full URL: the tracker appends its own path. */
+    apiUrl?: string;
+    /** Record scroll depth. Default `true`. */
+    trackScroll?: boolean;
+    /** Record outbound link clicks as `outbound_link` events. Default `true`. */
+    trackOutbound?: boolean;
+    /** Record file download clicks as `file_download` events. Default `true`. */
+    trackDownloads?: boolean;
+    /** Also load the companion script, which records clicks, copies and form
+     *  submits. A SECOND request on purpose: the core script's size is a
+     *  published claim and nothing may be folded into it. `true` records all
+     *  three; an object turns individual ones off. */
+    companion?: boolean | CompanionOptions;
+    /** Inject during `nuxt dev` as well. Off by default: the tracker has no
+     *  localhost guard, so a dev server would send real pageviews at production. */
+    injectInDev?: boolean;
+}
+export type DomainSource = "option" | "site" | "browser";
+export interface Resolution {
+    domain: string | null;
+    source: DomainSource;
+}
+/** Resolve the domain, saying WHERE it came from so the caller can log it.
+ *  Never throws for a missing domain — a null domain is a working install that
+ *  auto-detects — but an explicitly supplied domain that cannot be a hostname
+ *  is a typo, and a typo there is a silent no-data install, which is worth a
+ *  build error. */
+export declare function resolveDomain(options: ModuleOptions, site: string | URL | undefined | null): Resolution;
+/** One entry of Nuxt's `app.head.script` array. Deliberately not imported from
+ *  `@nuxt/schema` — this file must stay free of Nuxt so it can be tested
+ *  without one, and the shape is a plain attribute bag either way. */
+export type ScriptDescriptor = Record<string, string | boolean | undefined>;
+/** Normalise `companion` into the three booleans the second script needs, or
+ *  null when there is to be no second script. */
+export declare function resolveCompanion(companion: ModuleOptions["companion"]): {
+    clicks: boolean;
+    copy: boolean;
+    forms: boolean;
+} | null;
+/** The script descriptors to append to `app.head.script`, in order.
+ *
+ *  The core script is always first. The companion, when asked for, is a second
+ *  entry and never carries `data-domain` — it reads `window.pulse`, which the
+ *  core script owns.
+ *
+ *  ⚠️ `defer` is a boolean here and Unhead renders it as a BARE `defer`
+ *  attribute, which is what we want. It is spelled as a boolean rather than
+ *  the string `'defer'` because the string would ship `defer="defer"` — valid
+ *  HTML, a different byte-string, and one this project asserts against a real
+ *  rendered page rather than trusting. */
+export declare function buildScripts(domain: string | null, options?: ModuleOptions): ScriptDescriptor[];

package/dist/pulse.js

@@ -0,0 +1,132 @@
+// Pure logic for the Pulse Nuxt module: which script tags to add to the head,
+// and what domain to add them with. No Nuxt API in this file, so all of it is
+// unit-tested — and the rendered-page harness in `scripts/verify-build.mjs`
+// then proves what these descriptors actually become as bytes.
+//
+// 🔴 Nuxt is the one Pulse surface where the literal tag IS expressible.
+// Astro's `injectScript` takes JavaScript and never HTML, so `pulse-astro`
+// has to build the element in the DOM at runtime. Nuxt's head is a list of
+// element descriptors that Unhead serialises, so this module contributes a
+// real `<script src … defer data-domain …>` to the server-rendered HTML and
+// ships no code of its own to the browser. Measured, not assumed — see
+// RELEASING.md § "Compatibility is measured, not assumed".
+//
+// The option names deliberately match the `pulse-analytics` entry in
+// `@nuxt/scripts` (`domain`, `apiUrl`, `trackScroll`, `trackOutbound`,
+// `trackDownloads`). A Nuxt user can meet both, and two Pulse surfaces on one
+// framework disagreeing about what an option is called is a support ticket
+// waiting to happen.
+export const SCRIPT_URL = "https://js.ciphera.net/script.js";
+export const COMPANION_URL = "https://js.ciphera.net/script.interactions.js";
+/** A registrable hostname: labels of letters, digits and hyphens, at least one
+ *  dot, a letter-only TLD. Deliberately strict, and shared verbatim with
+ *  `pulse-astro` so the two agree on what a domain is. */
+const DOMAIN_RE = /^(?=.{1,253}$)(?!-)[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?(\.[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?)*\.[a-z]{2,63}$/;
+/** Lower-case, drop a scheme, path, port and trailing dot. Keeps `www.` — the
+ *  Pulse site may be registered either way and the user can override it. */
+export function normalizeDomain(input) {
+    let s = input.trim().toLowerCase();
+    s = s.replace(/^[a-z][a-z0-9+.-]*:\/\//, "");
+    s = s.replace(/[/?#].*$/, "");
+    s = s.replace(/:.*$/, "");
+    s = s.replace(/\.$/, "");
+    return s;
+}
+export function isValidDomain(domain) {
+    return DOMAIN_RE.test(domain);
+}
+/** The hostname of a site URL, or null when it is unset or does not parse.
+ *  Nuxt core has no `site` option; `nuxt-site-config` (which `@nuxtjs/sitemap`,
+ *  `@nuxtjs/robots` and `@nuxtjs/seo` all install) adds `site.url`, and this is
+ *  how we read it when it happens to be there. */
+export function hostnameFromSite(site) {
+    if (!site)
+        return null;
+    try {
+        const host = new URL(String(site)).hostname.toLowerCase().replace(/\.$/, "");
+        return isValidDomain(host) ? host : null;
+    }
+    catch {
+        return null;
+    }
+}
+/** Resolve the domain, saying WHERE it came from so the caller can log it.
+ *  Never throws for a missing domain — a null domain is a working install that
+ *  auto-detects — but an explicitly supplied domain that cannot be a hostname
+ *  is a typo, and a typo there is a silent no-data install, which is worth a
+ *  build error. */
+export function resolveDomain(options, site) {
+    if (options.domain !== undefined) {
+        const d = normalizeDomain(options.domain);
+        if (!isValidDomain(d)) {
+            throw new Error(`[pulse] "${options.domain}" is not a valid domain. Pass the hostname your site is registered under in Pulse, e.g. pulse: { domain: "example.com" }.`);
+        }
+        return { domain: d, source: "option" };
+    }
+    const fromSite = hostnameFromSite(site);
+    if (fromSite)
+        return { domain: fromSite, source: "site" };
+    return { domain: null, source: "browser" };
+}
+/** 🔴 A presence flag must be `''` or absent, NEVER a boolean.
+ *
+ *  Unhead normalises a `data-*` prop to a string before rendering, and its
+ *  emptiness guard tests the boolean `false`, not the string `"false"`. So
+ *  `'data-no-scroll': false` ships as `data-no-scroll="false"` — an attribute
+ *  that is PRESENT. The tracker reads these with `hasAttribute()`, so a
+ *  boolean `false` would switch the feature it names OFF: the exact inversion
+ *  of what the option asked for. Measured on Unhead 3.4, and the reason this
+ *  helper exists instead of a ternary at each call site. */
+function flag(disabled) {
+    return disabled ? "" : undefined;
+}
+/** Normalise `companion` into the three booleans the second script needs, or
+ *  null when there is to be no second script. */
+export function resolveCompanion(companion) {
+    if (!companion)
+        return null;
+    if (companion === true)
+        return { clicks: true, copy: true, forms: true };
+    return {
+        clicks: companion.clicks !== false,
+        copy: companion.copy !== false,
+        forms: companion.forms !== false,
+    };
+}
+/** The script descriptors to append to `app.head.script`, in order.
+ *
+ *  The core script is always first. The companion, when asked for, is a second
+ *  entry and never carries `data-domain` — it reads `window.pulse`, which the
+ *  core script owns.
+ *
+ *  ⚠️ `defer` is a boolean here and Unhead renders it as a BARE `defer`
+ *  attribute, which is what we want. It is spelled as a boolean rather than
+ *  the string `'defer'` because the string would ship `defer="defer"` — valid
+ *  HTML, a different byte-string, and one this project asserts against a real
+ *  rendered page rather than trusting. */
+export function buildScripts(domain, options = {}) {
+    if (domain !== null && !isValidDomain(domain)) {
+        throw new Error(`[pulse] refusing to inject an invalid domain: ${domain}`);
+    }
+    const core = {
+        src: SCRIPT_URL,
+        defer: true,
+        "data-domain": domain ?? undefined,
+        "data-api": options.apiUrl ? String(options.apiUrl).replace(/\/+$/, "") : undefined,
+        "data-no-scroll": flag(options.trackScroll === false),
+        "data-no-outbound": flag(options.trackOutbound === false),
+        "data-no-downloads": flag(options.trackDownloads === false),
+    };
+    const scripts = [core];
+    const companion = resolveCompanion(options.companion);
+    if (companion) {
+        scripts.push({
+            src: COMPANION_URL,
+            defer: true,
+            "data-no-clicks": flag(!companion.clicks),
+            "data-no-copy": flag(!companion.copy),
+            "data-no-forms": flag(!companion.forms),
+        });
+    }
+    return scripts;
+}

package/package.json

@@ -0,0 +1,60 @@
+{
+  "name": "@ciphera-net/pulse-nuxt",
+  "version": "1.0.0",
+  "description": "Add Pulse Analytics — privacy-first web analytics — to a Nuxt site with one module. No cookies, no personal data, under 3 KB.",
+  "type": "module",
+  "license": "Apache-2.0",
+  "homepage": "https://pulse.ciphera.net",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ciphera-net/pulse-nuxt.git"
+  },
+  "bugs": "https://github.com/ciphera-net/pulse-nuxt/issues",
+  "keywords": [
+    "nuxt",
+    "nuxt-module",
+    "nuxt3",
+    "nuxt4",
+    "analytics",
+    "privacy",
+    "pulse",
+    "gdpr"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/module.d.ts",
+      "default": "./dist/module.js"
+    },
+    "./module.json": "./dist/module.json"
+  },
+  "main": "./dist/module.js",
+  "types": "./dist/module.d.ts",
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "build": "tsc -p tsconfig.build.json && node scripts/emit-module-json.mjs",
+    "prepack": "npm run build",
+    "typecheck": "tsc --noEmit",
+    "test": "vitest run",
+    "verify": "node scripts/verify-build.mjs"
+  },
+  "peerDependencies": {
+    "nuxt": "^3.0.0 || ^4.0.0"
+  },
+  "devDependencies": {
+    "@nuxt/schema": "^4.5.2",
+    "nuxt": "^4.5.2",
+    "playwright-core": "^1.63.0",
+    "typescript": "^5.9.2",
+    "vitest": "^4.0.18"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "engines": {
+    "node": ">=20"
+  }
+}