@antelopejs/dms-marketing 0.2.2

package/LICENSE

@@ -0,0 +1,190 @@
+                                 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
+
+   Copyright (c) 2025-present - AntelopeJS Team
+
+   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,143 @@
+# @antelopejs/dms-marketing
+
+<div align="center">
+<a href="./LICENSE"><img alt="License" src="https://img.shields.io/badge/license-Apache--2.0-blue?style=for-the-badge&labelColor=000000"></a>
+<a href="https://discord.gg/sjK28QHrA7"><img src="https://img.shields.io/badge/Discord-18181B?logo=discord&style=for-the-badge&color=000000" alt="Discord"></a>
+<a href="https://antelopejs.com"><img src="https://img.shields.io/badge/Docs-18181B?style=for-the-badge&color=000000" alt="Documentation"></a>
+</div>
+
+Marketing analytics module for the AntelopeJS DMS: traffic dashboards,
+conversion funnels with optional A/B splits, and click heatmaps — fully
+first-party.
+No external service, no cookie; data stays in the project's MongoDB.
+
+<p align="center">
+  <img src="docs/screenshots/overview.png" alt="Overview: pageviews, sessions, new visitors and custom events, a traffic chart, a device split and the top pages, referrers, UTM sources and browsers" width="900">
+</p>
+<p align="center">
+  <em>The Overview page — every panel reads pre-aggregated daily rollups, never raw events.</em>
+</p>
+
+## Features
+
+| Feature | Where | Guide |
+|---|---|---|
+| **Traffic overview** — pageviews, sessions, visitors, top pages/referrers/UTM/browsers, device split; site registration and tracker snippet | `/modules/marketing/overview` | [usage/overview.md](docs/usage/overview.md) |
+| **Campaigns & channels** — direct/organic/social/referral/paid split, UTM campaign table (source × medium × campaign) | `/modules/marketing/campaigns` | [usage/campaigns.md](docs/usage/campaigns.md) |
+| **Click heatmaps** — clicks drawn over a snapshot of any tracked page | `/modules/marketing/pages` | [usage/heatmap.md](docs/usage/heatmap.md) |
+| **Funnels & A/B** — ordered conversion journeys with per-step drop-off, optionally split into server-assigned variations scored with significance | `/modules/marketing/funnels` | [usage/funnels.md](docs/usage/funnels.md) |
+| **First-party tracker** — cookieless script, SPA-aware, custom events API | visitor sites | [usage/tracking.md](docs/usage/tracking.md) |
+| **Settings** — collection switch, retentions, heatmap sampling | `/modules/marketing/settings` | [usage/settings.md](docs/usage/settings.md) |
+
+<p align="center">
+  <img src="docs/screenshots/heatmap.png" alt="Tracked pages: the inventory of visited paths on the left, and on the right the click heatmap of the selected path drawn over a live preview of the page" width="900">
+</p>
+<p align="center">
+  <em>Click heatmap over the page itself. Clicks are anchored to the element
+  they hit, so they stay on the right button at every viewport width.</em>
+</p>
+
+<p align="center">
+  <img src="docs/screenshots/funnels.png" alt="Funnels: the funnel list on the left, and on the right the conversion bars of the selected funnel, step by step, with the drop-off between steps" width="900">
+</p>
+<p align="center">
+  <em>Conversion funnels with per-step drop-off. Computed at read time over
+  the period's sessions, so a new definition immediately scores past traffic.</em>
+</p>
+
+<p align="center">
+  <img src="docs/screenshots/experiments.png" alt="A split funnel: the funnel list on the left, and on the right the verdict banner over the funnel drawn once per arm — control and challenger mirrored around the step they share, with the drop between steps in the taper" width="900">
+</p>
+<p align="center">
+  <em>The same funnel split into A/B arms: one figure per arm, arm against
+  arm at every step. Verdicts answer "not enough data" rather than
+  overclaim — a sample too thin shows raw counts, never bars.</em>
+</p>
+
+## What makes it hold
+
+- **First-party and cookieless.** Visitors are identified by a server-side
+  anonymous hash (salted monthly, raw inputs never stored) — the shape
+  audience-measurement consent exemptions ask for. Events store no IP, no
+  user agent, no headers. Page content is stored in one place only — the
+  heatmap's page snapshots — and that is opt-in per site, form values
+  always masked, under a short retention of its own.
+- **Dashboards never scan raw events.** Statistics are rolled up at write
+  time into one bounded row per website-day, counters as native server-side
+  increments; raw events are kept short-term only for heatmaps and funnel
+  computation.
+- **Heatmaps work on any site.** The surface is keyed on the pathnames the
+  tracker reports — no route registry, no sitemap, no framework convention —
+  clicks are anchored to the element they hit, not to screen coordinates,
+  and the backdrop is a snapshot the tracker captured in a visitor's
+  browser, so it shows on sites that refuse framing (most of them) and on
+  client-rendered ones alike.
+- **A/B without an experiment server or a client SDK.** A split is a
+  facet of a funnel, not a second object: variations are assigned
+  server-side from the same anonymous visitor hash, the page asks with one
+  call (`await dmsMarketing.variation("key")`), and the funnel's own steps
+  score the arms — z-test verdicts that answer "not enough data" rather
+  than overclaim.
+- **Tenant isolation is structural.** Analytics tables live in per-tenant
+  database instances, the same model as the rest of the DMS — not a filter
+  someone can forget.
+
+The reasoning behind each choice is in
+[docs/architecture.md](docs/architecture.md).
+
+## Documentation
+
+- **[Installation](docs/install.md)** — DMS side, visitor-site tracker embed,
+  development playground.
+- **[Usage guides](docs/usage/)** — one per feature, linked in the table above.
+- **[Architecture](docs/architecture.md)** — data flow, tenancy, auth model,
+  event contract, HTTP surface, heatmap internals, phasing.
+- **[Known issues](KNOWN-ISSUES.md)** — one open behavioural defect, found
+  end-to-end.
+
+## Status
+
+Pre-release, published on npm as `@antelopejs/dms-marketing`. Audience
+measurement, funnels, A/B splits and click heatmaps are functional end-to-end
+against the playground; session cohorts and session replay are not built yet.
+The full phase plan and current limits are in
+[architecture.md](docs/architecture.md#phasing).
+
+## Development
+
+This package is one half of the `dms-marketing` pnpm workspace; run the
+commands from the repository root.
+
+```bash
+pnpm install --filter @antelopejs/dms-marketing...
+pnpm --dir packages/dms-marketing/frontend-vue install
+pnpm build      # interface, then tsc
+pnpm lint       # oxlint + oxfmt over the backend, eslint over frontend-vue
+pnpm typecheck  # tsc over both packages, skipLibCheck off
+pnpm knip       # unused dependencies
+pnpm test       # backend suite, then the frontend module's vitest suite
+```
+
+The admin surfaces ship as a DMS frontend module in `frontend-vue/`: a Vue 3
+project whose root `dms.frontend.ts` registers every component under the
+`DmsMarketing` prefix, plus its own i18n catalogs. It is a separate project
+with a lockfile of its own, published inside this package's tarball and
+materialized by the DMS frontend loader (`ajs dms`) into the console's Inertia
+workspace. `pnpm --dir packages/dms-marketing test:frontend` builds it through
+the real loader — client bundle, SSR bundle and vue-tsc.
+
+The interface this module implements is the workspace's other package,
+`packages/interface-dms-marketing`, published under the same `@antelopejs`
+scope. This package consumes it through the fleet range
+`>=<interface version> <1.0.0`, which pnpm links to the sibling inside the
+workspace, so `pnpm build` builds the interface first.
+Each is released on its own from GitHub Actions — `release-interface.yml`
+then `release.yml`; the module's workflow refuses to run until the interface
+version it links is resolvable on npm.
+
+A full consumer project with a tracked demo site lives under `playground/` —
+setup in [docs/install.md](docs/install.md#4-development-playground).
+
+## License
+
+Apache-2.0

package/dist/config.d.ts

@@ -0,0 +1,13 @@
+export interface DmsMarketingConfig {
+    trackerEnabled: boolean;
+    rawEventsRetention: number;
+    statisticsRetention: number;
+    snapshotRetention: number;
+    sessionIdleTimeout: number;
+    heatmapSampleRate: number;
+    visitorHashSecret: string;
+    geoipDatabasePath: string;
+}
+export declare function setConfig(input?: Partial<DmsMarketingConfig>): void;
+export declare function applyConfigOverrides(overrides: Partial<DmsMarketingConfig>): void;
+export declare function getConfig(): DmsMarketingConfig;

package/dist/config.js

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setConfig = setConfig;
+exports.applyConfigOverrides = applyConfigOverrides;
+exports.getConfig = getConfig;
+const defu_1 = require("defu");
+const constants_1 = require("./types/constants");
+const DEFAULT_CONFIG = {
+    trackerEnabled: true,
+    rawEventsRetention: constants_1.DEFAULT_RAW_EVENTS_RETENTION_MS,
+    statisticsRetention: constants_1.DEFAULT_STATISTICS_RETENTION_MS,
+    snapshotRetention: constants_1.DEFAULT_SNAPSHOT_RETENTION_MS,
+    sessionIdleTimeout: constants_1.DEFAULT_SESSION_IDLE_TIMEOUT_MS,
+    heatmapSampleRate: constants_1.DEFAULT_HEATMAP_SAMPLE_RATIO,
+    visitorHashSecret: "",
+    geoipDatabasePath: "",
+};
+let baseConfig = DEFAULT_CONFIG;
+let globalConfig = DEFAULT_CONFIG;
+let runtimeOverrides = {};
+function mergeEffective() {
+    globalConfig = (0, defu_1.defu)(runtimeOverrides, baseConfig);
+}
+function setConfig(input) {
+    baseConfig = (0, defu_1.defu)(input ?? {}, DEFAULT_CONFIG);
+    mergeEffective();
+}
+function applyConfigOverrides(overrides) {
+    runtimeOverrides = overrides;
+    mergeEffective();
+}
+function getConfig() {
+    return globalConfig;
+}
+//# sourceMappingURL=config.js.map

package/dist/config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.js","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":";;AAuDA,8BAGC;AAED,oDAKC;AAED,8BAEC;AArED,+BAA4B;AAC5B,iDAM2B;AA6B3B,MAAM,cAAc,GAAuB;IACzC,cAAc,EAAE,IAAI;IACpB,kBAAkB,EAAE,2CAA+B;IACnD,mBAAmB,EAAE,2CAA+B;IACpD,iBAAiB,EAAE,yCAA6B;IAChD,kBAAkB,EAAE,2CAA+B;IACnD,iBAAiB,EAAE,wCAA4B;IAC/C,iBAAiB,EAAE,EAAE;IACrB,iBAAiB,EAAE,EAAE;CACtB,CAAC;AAEF,IAAI,UAAU,GAAuB,cAAc,CAAC;AACpD,IAAI,YAAY,GAAuB,cAAc,CAAC;AACtD,IAAI,gBAAgB,GAAgC,EAAE,CAAC;AAEvD,SAAS,cAAc;IACrB,YAAY,GAAG,IAAA,WAAI,EAAC,gBAAgB,EAAE,UAAU,CAAC,CAAC;AACpD,CAAC;AAED,SAAgB,SAAS,CAAC,KAAmC;IAC3D,UAAU,GAAG,IAAA,WAAI,EAAC,KAAK,IAAI,EAAE,EAAE,cAAc,CAAC,CAAC;IAC/C,cAAc,EAAE,CAAC;AACnB,CAAC;AAED,SAAgB,oBAAoB,CAClC,SAAsC;IAEtC,gBAAgB,GAAG,SAAS,CAAC;IAC7B,cAAc,EAAE,CAAC;AACnB,CAAC;AAED,SAAgB,SAAS;IACvB,OAAO,YAAY,CAAC;AACtB,CAAC"}

package/dist/data-api/body.d.ts

@@ -0,0 +1 @@
+export declare function parseBody(body: Buffer | string): Record<string, unknown>;

package/dist/data-api/body.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseBody = parseBody;
+const interface_api_1 = require("@antelopejs/interface-api");
+const constants_1 = require("@/types/constants");
+const INVALID_BODY_MESSAGE = "$page.marketing.errors.invalid_body";
+function parseBody(body) {
+    try {
+        return JSON.parse(typeof body === "string" ? body : body.toString());
+    }
+    catch {
+        throw new interface_api_1.HTTPResult(constants_1.HTTP_BAD_REQUEST, INVALID_BODY_MESSAGE);
+    }
+}
+//# sourceMappingURL=body.js.map

package/dist/data-api/body.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"body.js","sourceRoot":"","sources":["../../src/data-api/body.ts"],"names":[],"mappings":";;AAMA,8BAQC;AAdD,6DAAuD;AACvD,iDAAqD;AAErD,MAAM,oBAAoB,GAAG,qCAAqC,CAAC;AAGnE,SAAgB,SAAS,CAAC,IAAqB;IAC7C,IAAI,CAAC;QACH,OAAO,IAAI,CAAC,KAAK,CACf,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,EAAE,CACvB,CAAC;IAC/B,CAAC;IAAC,MAAM,CAAC;QACP,MAAM,IAAI,0BAAU,CAAC,4BAAgB,EAAE,oBAAoB,CAAC,CAAC;IAC/D,CAAC;AACH,CAAC"}

package/dist/data-api/funnels.d.ts

@@ -0,0 +1,32 @@
+import { type DataControllerCallback } from "@antelopejs/interface-data-api";
+import { FunnelsModel } from "@/db";
+import { Funnel, type FunnelExperiment, type FunnelStep } from "@/db/tables/funnels.table";
+declare const funnelsDataAPI_base: import("@antelopejs/interface-core/decorators").Class<import("@antelopejs/interface-data-api").ExtractDefCallbacks<{
+    new: DataControllerCallback;
+    edit: DataControllerCallback;
+    delete: DataControllerCallback;
+    get: DataControllerCallback;
+    list: DataControllerCallback;
+    select: import("@antelopejs/interface-data-api").DataControllerCallbackWithOptions<any>;
+    count: DataControllerCallback;
+    countBatch: import("@antelopejs/interface-data-api").DataControllerCallbackWithOptions<any>;
+    archive: DataControllerCallback;
+    restore: DataControllerCallback;
+}> & {
+    table: Funnel;
+}> & import("@antelopejs/interface-core/decorators").Class<object> & {
+    extend: <T extends import("@antelopejs/interface-api").ControllerClass>(this: T, location: string) => T;
+    location: string;
+};
+export declare class funnelsDataAPI extends funnelsDataAPI_base {
+    model: FunnelsModel;
+    _id: string;
+    websiteId: string;
+    name: string;
+    steps: FunnelStep[];
+    get conversionWindowHours(): number;
+    set conversionWindowHours(hours: number);
+    experiment: FunnelExperiment | null;
+    createdAt: Date;
+}
+export {};