@ciphera-net/pulse-docusaurus 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,115 @@
+# Pulse Analytics for Docusaurus
+
+Privacy-first analytics for a Docusaurus site, in one plugin. 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
+npm install @ciphera-net/pulse-docusaurus
+```
+
+```js
+// docusaurus.config.js
+module.exports = {
+  url: 'https://example.com',
+  plugins: [
+    '@ciphera-net/pulse-docusaurus',
+  ],
+}
+```
+
+That is the whole setup. The domain comes from your site's `url` config, which
+Docusaurus already requires you to set, so there is nothing else to configure.
+
+To pass options, use the array form:
+
+```js
+plugins: [
+  ['@ciphera-net/pulse-docusaurus', { companion: true }],
+],
+```
+
+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 `url` | The domain your site is registered under in Pulse Analytics. Pass this when `url` is not the domain you track, for example on a preview deployment. |
+| `companion` | `false` | Also record clicks, copies and form submits. A second, separate script — see below. |
+| `api` | — | Route events through your own proxy origin. A bare origin (`https://example.com`), not a full URL: the tracker appends its own path. |
+| `injectInDev` | `false` | Inject during `docusaurus start` too. Off by default — see below. |
+
+## Three things worth knowing
+
+**It does not run in `docusaurus start`.** The tracker has no localhost guard,
+so a dev server would send real pageviews at your production dashboard. The
+plugin disables itself outside a production build, exactly as Docusaurus's own
+`@docusaurus/plugin-google-gtag` does. 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 real tag, and there is no inline script.** This is worth
+saying because it is not true of every Pulse integration — the Astro one and the
+Google Tag Manager template both have to build the element at runtime, because
+neither platform's injection API can carry attributes. Docusaurus's
+`injectHtmlTags` serialises attributes directly, so what lands in your built HTML is:
+
+```html
+<script defer="defer" data-domain="example.com" src="https://js.ciphera.net/script.js"></script>
+```
+
+the same tag you would paste by hand. (The plugin emits a bare `defer`;
+Docusaurus's HTML minifier re-serialises every boolean attribute into its
+`name="name"` form, which it also does to Docusaurus's own script tags. The two
+are identical in HTML5, where any value means true. Build with
+`SKIP_HTML_MINIFICATION=true` and you will see the bare form.)
+
+**A strict Content-Security-Policy needs no `unsafe-inline` and no nonce for
+this plugin** — only `script-src https://js.ciphera.net` and
+`connect-src https://pulse-api.ciphera.net`.
+
+## A mistyped domain fails the build
+
+`domain: "exmaple .com"` throws at build time rather than quietly falling back to
+auto-detection. A typo there is an install that reports no data and looks fine,
+which is the worst outcome an analytics plugin can produce, so it is worth a red
+build instead.
+
+If you set no `domain` **and** no `url`, the plugin warns and lets the tracker
+auto-detect the browser's hostname — correct for a single-domain site, wrong for
+a site served on several.
+
+## 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
+
+`peerDependencies` claims what has actually been measured, not what seems
+likely: each release is verified by building a real Docusaurus site and reading
+the tag back out of the emitted HTML (`node scripts/verify-build.mjs 3.10.2 3.0.1`).
+See `RELEASING.md` for the table.
+
+## 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.
+
+Docusaurus is a trademark of Meta Platforms, Inc.; this is an independent plugin
+and is not affiliated with or endorsed by Meta or the Docusaurus project.

package/lib/index.d.ts

@@ -0,0 +1,15 @@
+import type { LoadContext, Plugin } from "@docusaurus/types";
+import { type PulseOptions } from "./pulse";
+export type { PulseOptions };
+export { SCRIPT_URL, COMPANION_URL, normalizeDomain, isValidDomain, hostnameFromUrl, buildHeadTags, resolveDomain, } from "./pulse";
+/**
+ * Pulse Analytics — privacy-first web analytics for Docusaurus.
+ *
+ *   // docusaurus.config.js
+ *   plugins: [
+ *     ['@ciphera-net/pulse-docusaurus', { domain: 'example.com' }],
+ *   ]
+ *
+ * The domain comes from the site's own `url` config unless you pass one.
+ */
+export default function pulseAnalytics(context: LoadContext, options?: PulseOptions): Plugin | null;

package/lib/index.js

@@ -0,0 +1,51 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.resolveDomain = exports.buildHeadTags = exports.hostnameFromUrl = exports.isValidDomain = exports.normalizeDomain = exports.COMPANION_URL = exports.SCRIPT_URL = void 0;
+exports.default = pulseAnalytics;
+const pulse_1 = require("./pulse");
+var pulse_2 = require("./pulse");
+Object.defineProperty(exports, "SCRIPT_URL", { enumerable: true, get: function () { return pulse_2.SCRIPT_URL; } });
+Object.defineProperty(exports, "COMPANION_URL", { enumerable: true, get: function () { return pulse_2.COMPANION_URL; } });
+Object.defineProperty(exports, "normalizeDomain", { enumerable: true, get: function () { return pulse_2.normalizeDomain; } });
+Object.defineProperty(exports, "isValidDomain", { enumerable: true, get: function () { return pulse_2.isValidDomain; } });
+Object.defineProperty(exports, "hostnameFromUrl", { enumerable: true, get: function () { return pulse_2.hostnameFromUrl; } });
+Object.defineProperty(exports, "buildHeadTags", { enumerable: true, get: function () { return pulse_2.buildHeadTags; } });
+Object.defineProperty(exports, "resolveDomain", { enumerable: true, get: function () { return pulse_2.resolveDomain; } });
+/** Compile-time proof that the tag shape `pulse.ts` builds — which is declared
+ *  there without importing Docusaurus, so the logic stays unit-testable — is
+ *  still the shape Docusaurus accepts. If their type moves, this reddens the
+ *  build instead of shipping a tag Docusaurus will reject at site-build time. */
+const _tagShapeMatches = (t) => t;
+void _tagShapeMatches;
+/**
+ * Pulse Analytics — privacy-first web analytics for Docusaurus.
+ *
+ *   // docusaurus.config.js
+ *   plugins: [
+ *     ['@ciphera-net/pulse-docusaurus', { domain: 'example.com' }],
+ *   ]
+ *
+ * The domain comes from the site's own `url` config unless you pass one.
+ */
+function pulseAnalytics(context, options = {}) {
+    // The tracker has no localhost guard, so `docusaurus start` would send real
+    // pageviews at production. Returning null is the sanctioned way for a plugin
+    // to self-disable (facebook/docusaurus#10286) and is what
+    // `@docusaurus/plugin-google-gtag` does; returning undefined would throw.
+    const isProd = process.env.NODE_ENV === "production";
+    if (!isProd && !options.injectInDev)
+        return null;
+    // 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 } = (0, pulse_1.resolveDomain)(options, context.siteConfig?.url);
+    if (source === "browser") {
+        console.warn("[pulse-docusaurus] no `url` in docusaurus.config and no `domain` option — the tag will auto-detect the browser's hostname. Set one of them if this site is served on more than one domain.");
+    }
+    const headTags = (0, pulse_1.buildHeadTags)(domain, options);
+    return {
+        name: "pulse-analytics",
+        injectHtmlTags() {
+            return { headTags };
+        },
+    };
+}

package/lib/pulse.d.ts

@@ -0,0 +1,70 @@
+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 Docusaurus's `url` config value, or null when it is unset or
+ *  does not parse as a registrable domain. `url` is mandatory in a Docusaurus
+ *  config, so this is the near-universal path — the Docusaurus equivalent of
+ *  Astro's `site` and of the Framer plugin reading `getPublishInfo()`.
+ *
+ *  `http://localhost:3000` deliberately returns null: `localhost` has no dot
+ *  and no TLD, so it fails `isValidDomain` and the caller falls back to
+ *  auto-detection instead of registering a site called "localhost". */
+export declare function hostnameFromUrl(url: string | undefined | null): string | null;
+export interface PulseOptions {
+    /** The domain the site is registered under in Pulse. Defaults to the
+     *  hostname of Docusaurus's `url` config. If neither is available the tag is
+     *  injected without `data-domain` and the tracker falls back to the browser's
+     *  own hostname — which is correct for a single-domain site. */
+    domain?: string;
+    /** 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. */
+    companion?: boolean;
+    /** Route events through your own proxy origin. The tracker appends its own
+     *  path, so this is a bare origin (`https://example.com`), not a full URL. */
+    api?: string;
+    /** Inject during `docusaurus start` 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" | "url" | "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 that does throw rather than silently auto-detect something
+ *  the user did not ask for. */
+export declare function resolveDomain(options: PulseOptions, siteUrl: string | undefined | null): Resolution;
+/** The shape Docusaurus's `injectHtmlTags` accepts, declared here so this file
+ *  stays free of Docusaurus imports. `src/index.ts` asserts at compile time
+ *  that it is assignable to Docusaurus's own `HtmlTagObject`, so a drift in
+ *  their type reddens the build rather than shipping. */
+export interface HtmlTagObject {
+    tagName: string;
+    attributes: Record<string, string | boolean>;
+}
+/** Exactly the tag Pulse's install panel emits, as tag objects.
+ *
+ *  🔑 This is the one surface in the queue that can emit the LITERAL tag.
+ *  Astro's `injectScript` takes JavaScript source and GTM's sandboxed
+ *  `injectScript(url, …)` has no attribute parameter, so both have to build the
+ *  element at runtime or configure through `window.pulseConfig`. Docusaurus
+ *  serialises `{tagName, attributes}` straight into the HTML, honouring
+ *  arbitrary `data-*` keys, so view-source here shows the real tag and there is
+ *  no inline script — which means no CSP nonce and no `unsafe-inline`.
+ *
+ *  Attribute ORDER is the canonical install order (`defer`, `data-domain`,
+ *  `data-api`, `src`) because Docusaurus serialises `Object.keys` in insertion
+ *  order, and a tag a user can diff against the docs is worth the care.
+ *
+ *  No `preconnect` hints, deliberately — `@docusaurus/plugin-google-gtag` emits
+ *  two, but Framer, Astro and GTM emit none, and one surface quietly performing
+ *  differently from the others is exactly the drift this file exists to stop. */
+export declare function buildHeadTags(domain: string | null, options?: PulseOptions): HtmlTagObject[];

package/lib/pulse.js

@@ -0,0 +1,113 @@
+"use strict";
+// Pure logic for the Pulse Docusaurus plugin: what tags to inject, and what
+// domain to inject them with. No Docusaurus API in this file, so all of it is
+// unit-tested.
+//
+// The decisions here deliberately mirror `pulse-astro/src/pulse.ts` and
+// `pulse-framer/src/pulse.ts`. Two Pulse install surfaces disagreeing about
+// what the tag looks like is a drift bug waiting to happen, so the URLs, the
+// domain grammar and the rule that the companion is a SECOND script are
+// copied, not re-derived.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.COMPANION_URL = exports.SCRIPT_URL = void 0;
+exports.normalizeDomain = normalizeDomain;
+exports.isValidDomain = isValidDomain;
+exports.hostnameFromUrl = hostnameFromUrl;
+exports.resolveDomain = resolveDomain;
+exports.buildHeadTags = buildHeadTags;
+exports.SCRIPT_URL = "https://js.ciphera.net/script.js";
+exports.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 — the value lands inside an HTML
+ *  attribute, and this shape cannot carry a quote, a space or a bracket.
+ *
+ *  Docusaurus escapes attribute values itself (`escape-html` in
+ *  `core/lib/server/htmlTags.js`), so this is the second of two guards rather
+ *  than the only one. It is kept anyway: a domain that cannot be a hostname is
+ *  a typo, and a typo is a silent no-data install. */
+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. */
+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;
+}
+function isValidDomain(domain) {
+    return DOMAIN_RE.test(domain);
+}
+/** The hostname of Docusaurus's `url` config value, or null when it is unset or
+ *  does not parse as a registrable domain. `url` is mandatory in a Docusaurus
+ *  config, so this is the near-universal path — the Docusaurus equivalent of
+ *  Astro's `site` and of the Framer plugin reading `getPublishInfo()`.
+ *
+ *  `http://localhost:3000` deliberately returns null: `localhost` has no dot
+ *  and no TLD, so it fails `isValidDomain` and the caller falls back to
+ *  auto-detection instead of registering a site called "localhost". */
+function hostnameFromUrl(url) {
+    if (!url)
+        return null;
+    try {
+        const host = new URL(String(url)).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 that does throw rather than silently auto-detect something
+ *  the user did not ask for. */
+function resolveDomain(options, siteUrl) {
+    if (options.domain !== undefined) {
+        const d = normalizeDomain(options.domain);
+        if (!isValidDomain(d)) {
+            throw new Error(`[pulse-docusaurus] "${options.domain}" is not a valid domain. Pass the hostname your site is registered under in Pulse, e.g. domain: "example.com".`);
+        }
+        return { domain: d, source: "option" };
+    }
+    const fromUrl = hostnameFromUrl(siteUrl);
+    if (fromUrl)
+        return { domain: fromUrl, source: "url" };
+    return { domain: null, source: "browser" };
+}
+/** Exactly the tag Pulse's install panel emits, as tag objects.
+ *
+ *  🔑 This is the one surface in the queue that can emit the LITERAL tag.
+ *  Astro's `injectScript` takes JavaScript source and GTM's sandboxed
+ *  `injectScript(url, …)` has no attribute parameter, so both have to build the
+ *  element at runtime or configure through `window.pulseConfig`. Docusaurus
+ *  serialises `{tagName, attributes}` straight into the HTML, honouring
+ *  arbitrary `data-*` keys, so view-source here shows the real tag and there is
+ *  no inline script — which means no CSP nonce and no `unsafe-inline`.
+ *
+ *  Attribute ORDER is the canonical install order (`defer`, `data-domain`,
+ *  `data-api`, `src`) because Docusaurus serialises `Object.keys` in insertion
+ *  order, and a tag a user can diff against the docs is worth the care.
+ *
+ *  No `preconnect` hints, deliberately — `@docusaurus/plugin-google-gtag` emits
+ *  two, but Framer, Astro and GTM emit none, and one surface quietly performing
+ *  differently from the others is exactly the drift this file exists to stop. */
+function buildHeadTags(domain, options = {}) {
+    if (domain !== null && !isValidDomain(domain)) {
+        throw new Error(`[pulse-docusaurus] refusing to inject an invalid domain: ${domain}`);
+    }
+    const attributes = { defer: true };
+    if (domain !== null)
+        attributes["data-domain"] = domain;
+    if (options.api)
+        attributes["data-api"] = String(options.api).replace(/\/+$/, "");
+    attributes["src"] = exports.SCRIPT_URL;
+    const tags = [{ tagName: "script", attributes }];
+    if (options.companion) {
+        // No `data-domain` on the companion: the tracker resolves the domain once,
+        // from the core script, and a second copy is a second thing to keep in step.
+        tags.push({ tagName: "script", attributes: { defer: true, src: exports.COMPANION_URL } });
+    }
+    return tags;
+}

package/package.json

@@ -0,0 +1,49 @@
+{
+  "name": "@ciphera-net/pulse-docusaurus",
+  "version": "1.0.0",
+  "description": "Add Pulse Analytics \u2014 privacy-first web analytics \u2014 to a Docusaurus site with one plugin. No cookies, no personal data, under 3 KB.",
+  "license": "Apache-2.0",
+  "homepage": "https://pulse.ciphera.net",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ciphera-net/pulse-docusaurus.git"
+  },
+  "bugs": "https://github.com/ciphera-net/pulse-docusaurus/issues",
+  "keywords": [
+    "docusaurus",
+    "docusaurus-plugin",
+    "analytics",
+    "privacy",
+    "cookieless",
+    "gdpr",
+    "pulse"
+  ],
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "files": [
+    "lib",
+    "README.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "build": "tsc -p tsconfig.build.json",
+    "prepack": "npm run build",
+    "typecheck": "tsc --noEmit",
+    "test": "vitest run",
+    "check:package": "node scripts/check-package.mjs"
+  },
+  "peerDependencies": {
+    "@docusaurus/core": "^3.0.0"
+  },
+  "devDependencies": {
+    "@docusaurus/types": "^3.10.2",
+    "typescript": "^5.9.2",
+    "vitest": "^4.0.18"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "engines": {
+    "node": ">=20"
+  }
+}