@molecule/app-analytics-mixpanel 1.0.0

package/LICENSE

@@ -0,0 +1,115 @@
+                                 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.
+
+      "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.
+
+      "Contribution" shall mean any work of authorship, including the
+      original version of the Work and any modifications or additions
+      to that Work, that is intentionally submitted to the 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.
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by the 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
+      patent license to make, have made, use, offer to sell, sell, import,
+      and otherwise transfer the Work.
+
+   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.
+
+   5. Submission of Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND.
+
+   8. Limitation of Liability. In no event and under no legal theory shall
+      any Contributor be liable to You for damages.
+
+   9. Accepting Warranty or Additional Liability.
+
+   Copyright 2026 Molecule Dev, Inc.
+
+   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/dist/index.d.ts

@@ -0,0 +1,44 @@
+/**
+ * Mixpanel analytics provider for molecule.dev frontend.
+ *
+ * @example
+ * ```typescript
+ * import { setProvider } from '@molecule/app-analytics'
+ * import { createProvider } from '@molecule/app-analytics-mixpanel'
+ *
+ * // Canonical wiring: read the browser-side token from Vite env and pass it
+ * // through options. Without a token, skip bonding — analytics calls no-op.
+ * // VITE_MIXPANEL_TOKEN below stands for `import.meta.env.VITE_MIXPANEL_TOKEN`
+ * // (write the `import.meta.env` read in your app's bond-setup file).
+ * const token = VITE_MIXPANEL_TOKEN as string | undefined
+ * if (token) {
+ *   setProvider(createProvider({ token }))
+ * }
+ * ```
+ *
+ * @remarks
+ * The provider does NOT read env itself — configuration flows in through
+ * `createProvider(options)`. The canonical env name is `VITE_MIXPANEL_TOKEN`
+ * (the `VITE_` prefix is required: Vite only embeds `VITE_`-prefixed vars
+ * into the client bundle, and molecule's scaffolded app `.env` only includes
+ * `VITE_*` secrets). Do NOT use the API-side twin name (`MIXPANEL_TOKEN`) in
+ * frontend code — that belongs to `@molecule/api-analytics-mixpanel` and
+ * never reaches the browser. The Mixpanel project token is a public
+ * browser-side credential, safe to embed client-side.
+ *
+ * Bonding without a token is failure-safe: `createProvider()` (and the lazy
+ * `provider` export, which cannot receive options) logs ONE console warning
+ * naming VITE_MIXPANEL_TOKEN and returns a no-op provider — the raw SDK would
+ * otherwise accept an empty token in total silence and every event would
+ * vanish with no breadcrumb. If events never appear in Mixpanel, check the
+ * browser console for that warning FIRST.
+ *
+ * `AnalyticsEvent.timestamp` is NOT honored: the Mixpanel browser SDK has no
+ * supported client-set timestamp and always stamps the time of capture. For
+ * historical timestamps use `@molecule/api-analytics-mixpanel` server-side.
+ *
+ * @module
+ */
+export * from './provider.js';
+export * from './types.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwCG;AAEH,cAAc,eAAe,CAAA;AAC7B,cAAc,YAAY,CAAA"}

package/dist/index.js

@@ -0,0 +1,44 @@
+/**
+ * Mixpanel analytics provider for molecule.dev frontend.
+ *
+ * @example
+ * ```typescript
+ * import { setProvider } from '@molecule/app-analytics'
+ * import { createProvider } from '@molecule/app-analytics-mixpanel'
+ *
+ * // Canonical wiring: read the browser-side token from Vite env and pass it
+ * // through options. Without a token, skip bonding — analytics calls no-op.
+ * // VITE_MIXPANEL_TOKEN below stands for `import.meta.env.VITE_MIXPANEL_TOKEN`
+ * // (write the `import.meta.env` read in your app's bond-setup file).
+ * const token = VITE_MIXPANEL_TOKEN as string | undefined
+ * if (token) {
+ *   setProvider(createProvider({ token }))
+ * }
+ * ```
+ *
+ * @remarks
+ * The provider does NOT read env itself — configuration flows in through
+ * `createProvider(options)`. The canonical env name is `VITE_MIXPANEL_TOKEN`
+ * (the `VITE_` prefix is required: Vite only embeds `VITE_`-prefixed vars
+ * into the client bundle, and molecule's scaffolded app `.env` only includes
+ * `VITE_*` secrets). Do NOT use the API-side twin name (`MIXPANEL_TOKEN`) in
+ * frontend code — that belongs to `@molecule/api-analytics-mixpanel` and
+ * never reaches the browser. The Mixpanel project token is a public
+ * browser-side credential, safe to embed client-side.
+ *
+ * Bonding without a token is failure-safe: `createProvider()` (and the lazy
+ * `provider` export, which cannot receive options) logs ONE console warning
+ * naming VITE_MIXPANEL_TOKEN and returns a no-op provider — the raw SDK would
+ * otherwise accept an empty token in total silence and every event would
+ * vanish with no breadcrumb. If events never appear in Mixpanel, check the
+ * browser console for that warning FIRST.
+ *
+ * `AnalyticsEvent.timestamp` is NOT honored: the Mixpanel browser SDK has no
+ * supported client-set timestamp and always stamps the time of capture. For
+ * historical timestamps use `@molecule/api-analytics-mixpanel` server-side.
+ *
+ * @module
+ */
+export * from './provider.js';
+export * from './types.js';
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwCG;AAEH,cAAc,eAAe,CAAA;AAC7B,cAAc,YAAY,CAAA"}

package/dist/provider.d.ts

@@ -0,0 +1,29 @@
+/**
+ * Mixpanel analytics provider for molecule.dev frontend.
+ *
+ * Uses the `mixpanel-browser` SDK.
+ *
+ * @module
+ */
+import type { AnalyticsProvider } from '@molecule/app-analytics';
+import type { MixpanelOptions } from './types.js';
+/**
+ * Creates a Mixpanel analytics provider using `mixpanel-browser`. Initializes the SDK
+ * with the provided token and returns an `AnalyticsProvider` that maps molecule events to
+ * Mixpanel's `track`, `identify`, `people.set`, and `set_group` APIs.
+ *
+ * When no token is provided, this does NOT initialize the SDK (mixpanel-browser
+ * accepts `init('')` in TOTAL silence and then sends every event to
+ * api.mixpanel.com with an empty token, where it is dropped server-side with no
+ * client-side breadcrumb): it logs one actionable warning naming
+ * VITE_MIXPANEL_TOKEN and returns a no-op provider, so bonding the lazy
+ * `provider` export without configuration degrades gracefully instead of
+ * becoming a silent event black hole.
+ *
+ * @param options - Mixpanel configuration including `token` and optional `debug` flag.
+ * @returns An `AnalyticsProvider` backed by the Mixpanel browser SDK.
+ */
+export declare const createProvider: (options?: MixpanelOptions) => AnalyticsProvider;
+/** Lazy-initialized Mixpanel analytics provider singleton. */
+export declare const provider: AnalyticsProvider;
+//# sourceMappingURL=provider.d.ts.map

package/dist/provider.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"provider.d.ts","sourceRoot":"","sources":["../src/provider.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAIH,OAAO,KAAK,EAGV,iBAAiB,EAElB,MAAM,yBAAyB,CAAA;AAEhC,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,YAAY,CAAA;AAEjD;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,cAAc,GAAI,UAAU,eAAe,KAAG,iBAmE1D,CAAA;AAID,8DAA8D;AAC9D,eAAO,MAAM,QAAQ,EAAE,iBAUrB,CAAA"}

package/dist/provider.js

@@ -0,0 +1,100 @@
+/**
+ * Mixpanel analytics provider for molecule.dev frontend.
+ *
+ * Uses the `mixpanel-browser` SDK.
+ *
+ * @module
+ */
+import mixpanel from 'mixpanel-browser';
+/**
+ * Creates a Mixpanel analytics provider using `mixpanel-browser`. Initializes the SDK
+ * with the provided token and returns an `AnalyticsProvider` that maps molecule events to
+ * Mixpanel's `track`, `identify`, `people.set`, and `set_group` APIs.
+ *
+ * When no token is provided, this does NOT initialize the SDK (mixpanel-browser
+ * accepts `init('')` in TOTAL silence and then sends every event to
+ * api.mixpanel.com with an empty token, where it is dropped server-side with no
+ * client-side breadcrumb): it logs one actionable warning naming
+ * VITE_MIXPANEL_TOKEN and returns a no-op provider, so bonding the lazy
+ * `provider` export without configuration degrades gracefully instead of
+ * becoming a silent event black hole.
+ *
+ * @param options - Mixpanel configuration including `token` and optional `debug` flag.
+ * @returns An `AnalyticsProvider` backed by the Mixpanel browser SDK.
+ */
+export const createProvider = (options) => {
+    const token = options?.token ?? '';
+    if (!token) {
+        // Graceful degradation with a breadcrumb: without this warning a missing
+        // token means events silently vanish (the SDK never complains), which is
+        // indistinguishable from a broken tracking call.
+        console.warn('[analytics] Mixpanel token not configured — analytics events will NOT be delivered. ' +
+            'Pass createProvider({ token }) (canonical source: import.meta.env.VITE_MIXPANEL_TOKEN) ' +
+            'or skip bonding the provider entirely.');
+        const noop = async () => { };
+        return {
+            identify: noop,
+            track: noop,
+            page: noop,
+            group: noop,
+            reset: noop,
+            flush: noop,
+        };
+    }
+    mixpanel.init(token, {
+        debug: options?.debug ?? false,
+        track_pageview: false, // We handle page views manually via auto-tracking
+    });
+    return {
+        async identify(user) {
+            mixpanel.identify(user.userId);
+            mixpanel.people.set({
+                $email: user.email,
+                $name: user.name,
+                ...user.traits,
+            });
+        },
+        async track(event) {
+            mixpanel.track(event.name, event.properties);
+        },
+        async page(pageView) {
+            mixpanel.track('Page View', {
+                page_name: pageView.name,
+                page_category: pageView.category,
+                page_url: pageView.url,
+                page_path: pageView.path,
+                page_referrer: pageView.referrer,
+                ...pageView.properties,
+            });
+        },
+        async group(groupId, traits) {
+            mixpanel.set_group('company', groupId);
+            if (traits) {
+                mixpanel.get_group('company', groupId).set(traits);
+            }
+        },
+        async reset() {
+            mixpanel.reset();
+        },
+        async flush() {
+            // mixpanel-browser sends events immediately, no explicit flush needed
+        },
+    };
+};
+/** Default Mixpanel provider instance (lazy-initialized via Proxy on first method call). */
+let _provider = null;
+/** Lazy-initialized Mixpanel analytics provider singleton. */
+export const provider = new Proxy({}, {
+    get(_, prop, receiver) {
+        if (!_provider)
+            _provider = createProvider();
+        return Reflect.get(_provider, prop, receiver);
+    },
+    // set trap: methods run with `this` bound to the proxy — without it, instance-state writes land on the dummy target and are lost (see api-push-notifications-web-push)
+    set(_, prop, value) {
+        if (!_provider)
+            _provider = createProvider();
+        return Reflect.set(_provider, prop, value);
+    },
+});
+//# sourceMappingURL=provider.js.map

package/dist/provider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"provider.js","sourceRoot":"","sources":["../src/provider.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,QAAQ,MAAM,kBAAkB,CAAA;AAWvC;;;;;;;;;;;;;;;GAeG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,OAAyB,EAAqB,EAAE;IAC7E,MAAM,KAAK,GAAG,OAAO,EAAE,KAAK,IAAI,EAAE,CAAA;IAClC,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,yEAAyE;QACzE,yEAAyE;QACzE,iDAAiD;QACjD,OAAO,CAAC,IAAI,CACV,sFAAsF;YACpF,yFAAyF;YACzF,wCAAwC,CAC3C,CAAA;QACD,MAAM,IAAI,GAAG,KAAK,IAAmB,EAAE,GAAE,CAAC,CAAA;QAC1C,OAAO;YACL,QAAQ,EAAE,IAAI;YACd,KAAK,EAAE,IAAI;YACX,IAAI,EAAE,IAAI;YACV,KAAK,EAAE,IAAI;YACX,KAAK,EAAE,IAAI;YACX,KAAK,EAAE,IAAI;SACZ,CAAA;IACH,CAAC;IAED,QAAQ,CAAC,IAAI,CAAC,KAAK,EAAE;QACnB,KAAK,EAAE,OAAO,EAAE,KAAK,IAAI,KAAK;QAC9B,cAAc,EAAE,KAAK,EAAE,kDAAkD;KAC1E,CAAC,CAAA;IAEF,OAAO;QACL,KAAK,CAAC,QAAQ,CAAC,IAAwB;YACrC,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;YAC9B,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC;gBAClB,MAAM,EAAE,IAAI,CAAC,KAAK;gBAClB,KAAK,EAAE,IAAI,CAAC,IAAI;gBAChB,GAAG,IAAI,CAAC,MAAM;aACf,CAAC,CAAA;QACJ,CAAC;QAED,KAAK,CAAC,KAAK,CAAC,KAAqB;YAC/B,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,UAAU,CAAC,CAAA;QAC9C,CAAC;QAED,KAAK,CAAC,IAAI,CAAC,QAA2B;YACpC,QAAQ,CAAC,KAAK,CAAC,WAAW,EAAE;gBAC1B,SAAS,EAAE,QAAQ,CAAC,IAAI;gBACxB,aAAa,EAAE,QAAQ,CAAC,QAAQ;gBAChC,QAAQ,EAAE,QAAQ,CAAC,GAAG;gBACtB,SAAS,EAAE,QAAQ,CAAC,IAAI;gBACxB,aAAa,EAAE,QAAQ,CAAC,QAAQ;gBAChC,GAAG,QAAQ,CAAC,UAAU;aACvB,CAAC,CAAA;QACJ,CAAC;QAED,KAAK,CAAC,KAAK,CAAC,OAAe,EAAE,MAAgC;YAC3D,QAAQ,CAAC,SAAS,CAAC,SAAS,EAAE,OAAO,CAAC,CAAA;YACtC,IAAI,MAAM,EAAE,CAAC;gBACX,QAAQ,CAAC,SAAS,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAA;YACpD,CAAC;QACH,CAAC;QAED,KAAK,CAAC,KAAK;YACT,QAAQ,CAAC,KAAK,EAAE,CAAA;QAClB,CAAC;QAED,KAAK,CAAC,KAAK;YACT,sEAAsE;QACxE,CAAC;KACF,CAAA;AACH,CAAC,CAAA;AAED,4FAA4F;AAC5F,IAAI,SAAS,GAA6B,IAAI,CAAA;AAC9C,8DAA8D;AAC9D,MAAM,CAAC,MAAM,QAAQ,GAAsB,IAAI,KAAK,CAAC,EAAuB,EAAE;IAC5E,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,QAAQ;QACnB,IAAI,CAAC,SAAS;YAAE,SAAS,GAAG,cAAc,EAAE,CAAA;QAC5C,OAAO,OAAO,CAAC,GAAG,CAAC,SAAS,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAA;IAC/C,CAAC;IACD,uKAAuK;IACvK,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK;QAChB,IAAI,CAAC,SAAS;YAAE,SAAS,GAAG,cAAc,EAAE,CAAA;QAC5C,OAAO,OAAO,CAAC,GAAG,CAAC,SAAS,EAAE,IAAI,EAAE,KAAK,CAAC,CAAA;IAC5C,CAAC;CACF,CAAC,CAAA"}

package/dist/types.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Mixpanel app analytics types for molecule.dev.
+ *
+ * @module
+ */
+export type { AnalyticsEvent, AnalyticsPageView, AnalyticsProvider, AnalyticsUserProps, } from '@molecule/app-analytics';
+/**
+ * Options for creating a Mixpanel provider.
+ */
+export interface MixpanelOptions {
+    token?: string;
+    debug?: boolean;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,YAAY,EACV,cAAc,EACd,iBAAiB,EACjB,iBAAiB,EACjB,kBAAkB,GACnB,MAAM,yBAAyB,CAAA;AAEhC;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,KAAK,CAAC,EAAE,OAAO,CAAA;CAChB"}

package/dist/types.js

@@ -0,0 +1,7 @@
+/**
+ * Mixpanel app analytics types for molecule.dev.
+ *
+ * @module
+ */
+export {};
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;;GAIG"}

package/package.json

@@ -0,0 +1,50 @@
+{
+  "name": "@molecule/app-analytics-mixpanel",
+  "version": "1.0.0",
+  "description": "Mixpanel analytics provider for molecule.dev frontend",
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "tsc",
+    "test": "vitest run",
+    "test:watch": "vitest"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "keywords": [
+    "molecule",
+    "analytics",
+    "mixpanel"
+  ],
+  "license": "Apache-2.0",
+  "dependencies": {
+    "mixpanel-browser": "2.81.0"
+  },
+  "peerDependencies": {
+    "@molecule/app-analytics": "^1.0.0"
+  },
+  "devDependencies": {
+    "@molecule/app-analytics": "1.0.0",
+    "@types/node": "26.1.2",
+    "typescript": "6.0.3",
+    "vitest": "4.1.10"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/molecule-dev/molecule.git",
+    "directory": "packages/app/bonds/analytics/mixpanel"
+  },
+  "homepage": "https://github.com/molecule-dev/molecule/tree/main/packages/app/bonds/analytics/mixpanel",
+  "bugs": "https://github.com/molecule-dev/molecule/issues",
+  "publishConfig": {
+    "access": "public"
+  }
+}