@arivie/source-mixpanel 0.1.0

package/LICENSE

@@ -0,0 +1,204 @@
+Copyright 2026 Arivie Contributors
+
+
+                                 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,55 @@
+# @arivie/source-mixpanel
+
+Mixpanel Query API `SourceAdapter` for Arivie (RFC-003 v2 REQ-41).
+
+## Usage
+
+```ts
+import { mixpanelAdapter } from "@arivie/source-mixpanel";
+
+const mixpanel = mixpanelAdapter({
+  projectToken: process.env.MIXPANEL_TOKEN!,
+  projectId: process.env.MIXPANEL_PROJECT_ID!,
+});
+
+// Wire into defineArivie sources (C45):
+// sources: { mixpanel }
+```
+
+## Authentication
+
+Query API requests use HTTP Basic Auth: the project API secret (or service-account
+credential) as the username with an empty password. See
+[Mixpanel Project Secret](https://developer.mixpanel.com/reference/project-secret).
+
+## Read-only tokens
+
+On the first `execute()` call, the adapter probes the Import API. If the
+credential can successfully import events, construction fails with a clear error.
+Mixpanel does not expose a dedicated read-only scope endpoint — configure
+query-only tokens in your Mixpanel project settings.
+
+## Live tests (HS-5)
+
+```bash
+MIXPANEL_TOKEN=... MIXPANEL_PROJECT_ID=... pnpm --filter @arivie/source-mixpanel test
+```
+
+When credentials are absent, `test/live.test.ts` is skipped and logs
+`[HS-5] Mixpanel creds missing — running mock-only`. Mock fixtures in
+`test/fixtures/mock-mixpanel-responses.ts` exercise deterministic query paths.
+
+## Query shape
+
+```ts
+interface MixpanelQuery {
+  event?: string;
+  aggregate?: "count" | "sum" | "average";
+  from_date: string; // yyyy-mm-dd
+  to_date: string;
+  where?: string;
+  on?: string;
+}
+```
+
+`compileMetric` is defined for REQ-43; the agent dispatcher lands in Sprint 3 C61.

package/dist/index.cjs

@@ -0,0 +1,344 @@
+'use strict';
+
+var crypto = require('crypto');
+
+// src/adapter.ts
+
+// src/compile-metric.ts
+function defaultDateRange() {
+  const to = /* @__PURE__ */ new Date();
+  const from = new Date(to);
+  from.setUTCDate(from.getUTCDate() - 30);
+  return {
+    from_date: formatDate(from),
+    to_date: formatDate(to)
+  };
+}
+function formatDate(d) {
+  return d.toISOString().slice(0, 10);
+}
+function compileMetricForMixpanel(opts) {
+  const { entity, metric } = opts;
+  const measure = entity.measures?.find((m) => m.name === metric);
+  if (measure == null) {
+    throw new Error(
+      `compileMetricForMixpanel: metric '${metric}' not found on entity '${entity.name}'`
+    );
+  }
+  const range = defaultDateRange();
+  const sql = measure.sql.toLowerCase();
+  let aggregate = "count";
+  if (sql.includes("sum(")) {
+    aggregate = "sum";
+  } else if (sql.includes("avg(") || sql.includes("average")) {
+    aggregate = "average";
+  }
+  const eventDim = entity.dimensions?.find((d) => d.name === "event_name");
+  const event = typeof opts.filters?.event_name === "string" ? opts.filters.event_name : typeof opts.filters?.event === "string" ? opts.filters.event : eventDim != null ? void 0 : entity.name;
+  const query = {
+    ...range,
+    aggregate,
+    ...event != null ? { event } : {}
+  };
+  if (aggregate === "sum") {
+    const onDim = entity.dimensions?.find((d) => d.name !== "event_name");
+    query.on = onDim?.sql ?? 'properties["$amount"]';
+  }
+  return { query };
+}
+
+// src/query.ts
+var READ_ONLY_REQUIRED_MSG = "MixpanelAdapter: read-only API token required; got token with write scope";
+function aggregateToSegmentationType(aggregate) {
+  switch (aggregate) {
+    case "average":
+      return "average";
+    case "sum":
+      return "general";
+    case "count":
+    default:
+      return "general";
+  }
+}
+function requiresSumEndpoint(query) {
+  return query.aggregate === "sum" && query.on != null && query.on !== "";
+}
+function buildSegmentationSearchParams(query, projectId) {
+  const params = new URLSearchParams();
+  params.set("project_id", projectId);
+  if (query.event) {
+    params.set("event", query.event);
+  }
+  params.set("from_date", query.from_date);
+  params.set("to_date", query.to_date);
+  if (query.where) {
+    params.set("where", query.where);
+  }
+  if (query.on && !requiresSumEndpoint(query)) {
+    params.set("on", query.on);
+  }
+  params.set("type", aggregateToSegmentationType(query.aggregate));
+  return params;
+}
+function buildSumSearchParams(query, projectId) {
+  const params = new URLSearchParams();
+  params.set("project_id", projectId);
+  if (query.event) {
+    params.set("event", query.event);
+  }
+  params.set("fromDate", query.from_date);
+  params.set("toDate", query.to_date);
+  if (query.on) {
+    params.set("on", query.on);
+  }
+  if (query.where) {
+    params.set("where", query.where);
+  }
+  return params;
+}
+function parseSegmentationData(data, eventName) {
+  if (data == null || typeof data !== "object") {
+    return [];
+  }
+  const root = data;
+  if (root.results && typeof root.results === "object") {
+    return Object.entries(root.results).map(([date, value]) => {
+      const row = {
+        date,
+        value: Number(value)
+      };
+      if (eventName != null) {
+        row.event = eventName;
+      }
+      return row;
+    });
+  }
+  const series = root.data?.series ?? [];
+  const values = root.data?.values ?? {};
+  const rows = [];
+  for (const [segment, byDate] of Object.entries(values)) {
+    for (const date of series) {
+      const raw = byDate[date];
+      if (raw == null) {
+        continue;
+      }
+      rows.push({
+        date,
+        value: Number(raw),
+        event: eventName ?? segment,
+        segment
+      });
+    }
+  }
+  if (rows.length === 0 && eventName != null) {
+    const direct = values[eventName];
+    if (direct) {
+      for (const [date, raw] of Object.entries(direct)) {
+        rows.push({ date, value: Number(raw), event: eventName });
+      }
+    }
+  }
+  return rows;
+}
+function sumRowValues(rows) {
+  return rows.reduce((acc, r) => acc + r.value, 0);
+}
+function compileMetricQuery(opts) {
+  return compileMetricForMixpanel(opts).query;
+}
+
+// src/execute.ts
+function queryApiBaseUrl(region = "mixpanel") {
+  return `https://${region}.com/api/query`;
+}
+function importApiBaseUrl(region = "mixpanel") {
+  const host = region === "mixpanel" ? "api.mixpanel.com" : `api.${region}.com`;
+  return `https://${host}`;
+}
+function basicAuthHeader(projectToken) {
+  const encoded = Buffer.from(`${projectToken}:`).toString("base64");
+  return `Basic ${encoded}`;
+}
+async function mixpanelGet(config, path, params, signal) {
+  const url = `${config.queryBaseUrl}${path}?${params.toString()}`;
+  const init = {
+    method: "GET",
+    headers: {
+      Authorization: basicAuthHeader(config.projectToken),
+      Accept: "application/json"
+    }
+  };
+  if (signal != null) {
+    init.signal = signal;
+  }
+  const res = await config.fetch(url, init);
+  const text = await res.text();
+  let body = null;
+  if (text.length > 0) {
+    try {
+      body = JSON.parse(text);
+    } catch {
+      body = { raw: text };
+    }
+  }
+  if (!res.ok) {
+    const detail = body && typeof body === "object" && "error" in body ? String(body.error) : text.slice(0, 200);
+    throw new Error(
+      `Mixpanel Query API ${path} failed (${res.status}): ${detail}`
+    );
+  }
+  return body;
+}
+async function probeWriteScope(config) {
+  const url = `${config.importBaseUrl}/import?strict=1&project_id=${encodeURIComponent(config.projectId)}`;
+  const probeBody = JSON.stringify([
+    {
+      event: "__arivie_readonly_probe__",
+      properties: {
+        distinct_id: "__arivie_probe__",
+        time: Math.floor(Date.now() / 1e3),
+        $insert_id: `arivie-probe-${Date.now()}`
+      }
+    }
+  ]);
+  const res = await config.fetch(url, {
+    method: "POST",
+    headers: {
+      Authorization: basicAuthHeader(config.projectToken),
+      "Content-Type": "application/json"
+    },
+    body: probeBody
+  });
+  if (res.status === 401 || res.status === 403) {
+    return false;
+  }
+  const text = await res.text();
+  if (!res.ok) {
+    return false;
+  }
+  try {
+    const parsed = JSON.parse(text);
+    if (parsed.status === "ok" || parsed.code === 200) {
+      return true;
+    }
+  } catch {
+    if (res.ok) {
+      return true;
+    }
+  }
+  return false;
+}
+async function fetchSegmentation(config, query, signal) {
+  if (requiresSumEndpoint(query)) {
+    const params2 = buildSumSearchParams(query, config.projectId);
+    return mixpanelGet(config, "/segmentation/sum", params2, signal);
+  }
+  const params = buildSegmentationSearchParams(query, config.projectId);
+  return mixpanelGet(config, "/segmentation", params, signal);
+}
+async function fetchEventNames(config) {
+  const params = new URLSearchParams();
+  params.set("project_id", config.projectId);
+  params.set("type", "general");
+  const body = await mixpanelGet(config, "/events/names", params);
+  if (Array.isArray(body)) {
+    return body.filter((x) => typeof x === "string");
+  }
+  return [];
+}
+async function executeMixpanelQuery(config, opts) {
+  const startedAt = Date.now();
+  const controller = new AbortController();
+  const timeout = setTimeout(() => controller.abort(), opts.timeoutMs);
+  try {
+    const raw = await fetchSegmentation(config, opts.query, controller.signal);
+    const parsed = parseSegmentationData(raw, opts.query.event);
+    const rows = parsed.map((r) => ({
+      date: r.date,
+      value: r.value,
+      event: r.event ?? opts.query.event,
+      segment: r.segment
+    }));
+    const truncated = rows.length > opts.rowLimit;
+    const limited = rows.slice(0, opts.rowLimit);
+    return {
+      rows: limited,
+      rowCount: limited.length,
+      durationMs: Date.now() - startedAt,
+      truncated
+    };
+  } finally {
+    clearTimeout(timeout);
+  }
+}
+
+// src/adapter.ts
+function deriveMixpanelAdapterId(projectId, projectToken) {
+  const hash = crypto.createHash("sha256").update(projectToken).digest("hex").slice(0, 12);
+  return `mixpanel:${projectId}:${hash}`;
+}
+function hashProjectToken(projectToken) {
+  return crypto.createHash("sha256").update(projectToken).digest("hex").slice(0, 12);
+}
+function mixpanelAdapter(opts) {
+  const region = opts.region ?? "mixpanel";
+  const projectId = String(opts.projectId);
+  const clientConfig = {
+    projectToken: opts.projectToken,
+    projectId,
+    queryBaseUrl: queryApiBaseUrl(region),
+    importBaseUrl: importApiBaseUrl(region),
+    fetch: opts.fetch ?? globalThis.fetch
+  };
+  let introspectCache = null;
+  let readOnlyVerified = opts.skipReadOnlyProbe === true;
+  async function ensureReadOnly() {
+    if (readOnlyVerified) {
+      return;
+    }
+    const writable = await probeWriteScope(clientConfig);
+    readOnlyVerified = true;
+    if (writable) {
+      throw new Error(READ_ONLY_REQUIRED_MSG);
+    }
+  }
+  return {
+    kind: "mixpanel",
+    id: deriveMixpanelAdapterId(projectId, opts.projectToken),
+    async execute(executeOpts) {
+      await ensureReadOnly();
+      return executeMixpanelQuery(clientConfig, executeOpts);
+    },
+    async introspect() {
+      if (introspectCache != null) {
+        return introspectCache;
+      }
+      await ensureReadOnly();
+      const names = await fetchEventNames(clientConfig);
+      introspectCache = names.map((name) => ({ name }));
+      return introspectCache;
+    },
+    async verifyOwnerIdentity() {
+    },
+    compileMetric: compileMetricForMixpanel
+  };
+}
+
+exports.READ_ONLY_REQUIRED_MSG = READ_ONLY_REQUIRED_MSG;
+exports.aggregateToSegmentationType = aggregateToSegmentationType;
+exports.basicAuthHeader = basicAuthHeader;
+exports.buildSegmentationSearchParams = buildSegmentationSearchParams;
+exports.buildSumSearchParams = buildSumSearchParams;
+exports.compileMetricForMixpanel = compileMetricForMixpanel;
+exports.compileMetricQuery = compileMetricQuery;
+exports.deriveMixpanelAdapterId = deriveMixpanelAdapterId;
+exports.executeMixpanelQuery = executeMixpanelQuery;
+exports.fetchEventNames = fetchEventNames;
+exports.fetchSegmentation = fetchSegmentation;
+exports.hashProjectToken = hashProjectToken;
+exports.importApiBaseUrl = importApiBaseUrl;
+exports.mixpanelAdapter = mixpanelAdapter;
+exports.parseSegmentationData = parseSegmentationData;
+exports.probeWriteScope = probeWriteScope;
+exports.queryApiBaseUrl = queryApiBaseUrl;
+exports.sumRowValues = sumRowValues;

package/dist/index.d.cts

@@ -0,0 +1,91 @@
+import { SourceAdapter, SourceAdapterCompileMetricOpts, SourceAdapterExecuteOpts, SourceAdapterExecuteResult } from '@arivie/core/types';
+
+/** Segmentation query routed to the Mixpanel Query API. */
+interface MixpanelQuery {
+    event?: string;
+    aggregate?: "count" | "sum" | "average";
+    from_date: string;
+    to_date: string;
+    where?: string;
+    on?: string;
+}
+interface MixpanelAdapterOptions {
+    /** Project API secret or service-account credential (HTTP Basic username). */
+    projectToken: string;
+    projectId: number | string;
+    name?: string;
+    /** Query API host prefix, e.g. `mixpanel` (US) or `eu.mixpanel`. */
+    region?: "mixpanel" | "eu.mixpanel" | "in.mixpanel";
+    /** Override for tests — custom fetch implementation. */
+    fetch?: typeof globalThis.fetch;
+    /** When true, skip the read-only import probe (tests only). */
+    skipReadOnlyProbe?: boolean;
+}
+type MixpanelAdapter = SourceAdapter<MixpanelQuery>;
+interface MixpanelEventInfo {
+    name: string;
+}
+
+/** Credential-safe adapter id (RFC-003 v2 §4.7). */
+declare function deriveMixpanelAdapterId(projectId: string | number, projectToken: string): string;
+declare function hashProjectToken(projectToken: string): string;
+/**
+ * Mixpanel Query API adapter (RFC-003 v2 REQ-41).
+ *
+ * Authenticates with HTTP Basic Auth: project token/secret as username, empty
+ * password (see Mixpanel Project Secret / Project Token docs).
+ *
+ * Read-only enforcement probes the Import API on first `execute()` (Mixpanel
+ * does not expose a dedicated read-only scope endpoint).
+ */
+declare function mixpanelAdapter(opts: MixpanelAdapterOptions): MixpanelAdapter;
+
+/**
+ * Compiles a semantic-layer measure on a Mixpanel-bound entity to a Query API payload.
+ */
+declare function compileMetricForMixpanel(opts: SourceAdapterCompileMetricOpts): {
+    query: MixpanelQuery;
+    params?: unknown[];
+};
+
+interface MixpanelClientConfig {
+    projectToken: string;
+    projectId: string;
+    queryBaseUrl: string;
+    importBaseUrl: string;
+    fetch: typeof globalThis.fetch;
+}
+declare function queryApiBaseUrl(region?: "mixpanel" | "eu.mixpanel" | "in.mixpanel"): string;
+declare function importApiBaseUrl(region?: "mixpanel" | "eu.mixpanel" | "in.mixpanel"): string;
+declare function basicAuthHeader(projectToken: string): string;
+/**
+ * Probes the Import API to detect write-capable credentials.
+ *
+ * Mixpanel does not expose a dedicated "read-only" scope flag on tokens.
+ * When import accepts data (HTTP 200 with success), the credential can write.
+ * Documented limitation: enforcement depends on the token permissions the
+ * consumer configured in Mixpanel project settings.
+ */
+declare function probeWriteScope(config: MixpanelClientConfig): Promise<boolean>;
+declare function fetchSegmentation(config: MixpanelClientConfig, query: MixpanelQuery, signal?: AbortSignal): Promise<unknown>;
+declare function fetchEventNames(config: MixpanelClientConfig): Promise<string[]>;
+declare function executeMixpanelQuery(config: MixpanelClientConfig, opts: SourceAdapterExecuteOpts<MixpanelQuery>): Promise<SourceAdapterExecuteResult<Record<string, unknown>>>;
+
+declare const READ_ONLY_REQUIRED_MSG = "MixpanelAdapter: read-only API token required; got token with write scope";
+/** Maps adapter aggregate to Mixpanel segmentation `type`. */
+declare function aggregateToSegmentationType(aggregate: MixpanelQuery["aggregate"] | undefined): "general" | "unique" | "average";
+declare function buildSegmentationSearchParams(query: MixpanelQuery, projectId: string): URLSearchParams;
+declare function buildSumSearchParams(query: MixpanelQuery, projectId: string): URLSearchParams;
+interface SegmentationSeriesRow {
+    date: string;
+    value: number;
+    event?: string;
+    segment?: string;
+}
+/** Flattens Mixpanel segmentation JSON into tabular rows. */
+declare function parseSegmentationData(data: unknown, eventName?: string): SegmentationSeriesRow[];
+declare function sumRowValues(rows: SegmentationSeriesRow[]): number;
+/** @deprecated Use {@link compileMetricForMixpanel} from `./compile-metric.js`. */
+declare function compileMetricQuery(opts: Parameters<typeof compileMetricForMixpanel>[0]): MixpanelQuery;
+
+export { type MixpanelAdapter, type MixpanelAdapterOptions, type MixpanelClientConfig, type MixpanelEventInfo, type MixpanelQuery, READ_ONLY_REQUIRED_MSG, type SegmentationSeriesRow, aggregateToSegmentationType, basicAuthHeader, buildSegmentationSearchParams, buildSumSearchParams, compileMetricForMixpanel, compileMetricQuery, deriveMixpanelAdapterId, executeMixpanelQuery, fetchEventNames, fetchSegmentation, hashProjectToken, importApiBaseUrl, mixpanelAdapter, parseSegmentationData, probeWriteScope, queryApiBaseUrl, sumRowValues };

package/dist/index.d.ts

@@ -0,0 +1,91 @@
+import { SourceAdapter, SourceAdapterCompileMetricOpts, SourceAdapterExecuteOpts, SourceAdapterExecuteResult } from '@arivie/core/types';
+
+/** Segmentation query routed to the Mixpanel Query API. */
+interface MixpanelQuery {
+    event?: string;
+    aggregate?: "count" | "sum" | "average";
+    from_date: string;
+    to_date: string;
+    where?: string;
+    on?: string;
+}
+interface MixpanelAdapterOptions {
+    /** Project API secret or service-account credential (HTTP Basic username). */
+    projectToken: string;
+    projectId: number | string;
+    name?: string;
+    /** Query API host prefix, e.g. `mixpanel` (US) or `eu.mixpanel`. */
+    region?: "mixpanel" | "eu.mixpanel" | "in.mixpanel";
+    /** Override for tests — custom fetch implementation. */
+    fetch?: typeof globalThis.fetch;
+    /** When true, skip the read-only import probe (tests only). */
+    skipReadOnlyProbe?: boolean;
+}
+type MixpanelAdapter = SourceAdapter<MixpanelQuery>;
+interface MixpanelEventInfo {
+    name: string;
+}
+
+/** Credential-safe adapter id (RFC-003 v2 §4.7). */
+declare function deriveMixpanelAdapterId(projectId: string | number, projectToken: string): string;
+declare function hashProjectToken(projectToken: string): string;
+/**
+ * Mixpanel Query API adapter (RFC-003 v2 REQ-41).
+ *
+ * Authenticates with HTTP Basic Auth: project token/secret as username, empty
+ * password (see Mixpanel Project Secret / Project Token docs).
+ *
+ * Read-only enforcement probes the Import API on first `execute()` (Mixpanel
+ * does not expose a dedicated read-only scope endpoint).
+ */
+declare function mixpanelAdapter(opts: MixpanelAdapterOptions): MixpanelAdapter;
+
+/**
+ * Compiles a semantic-layer measure on a Mixpanel-bound entity to a Query API payload.
+ */
+declare function compileMetricForMixpanel(opts: SourceAdapterCompileMetricOpts): {
+    query: MixpanelQuery;
+    params?: unknown[];
+};
+
+interface MixpanelClientConfig {
+    projectToken: string;
+    projectId: string;
+    queryBaseUrl: string;
+    importBaseUrl: string;
+    fetch: typeof globalThis.fetch;
+}
+declare function queryApiBaseUrl(region?: "mixpanel" | "eu.mixpanel" | "in.mixpanel"): string;
+declare function importApiBaseUrl(region?: "mixpanel" | "eu.mixpanel" | "in.mixpanel"): string;
+declare function basicAuthHeader(projectToken: string): string;
+/**
+ * Probes the Import API to detect write-capable credentials.
+ *
+ * Mixpanel does not expose a dedicated "read-only" scope flag on tokens.
+ * When import accepts data (HTTP 200 with success), the credential can write.
+ * Documented limitation: enforcement depends on the token permissions the
+ * consumer configured in Mixpanel project settings.
+ */
+declare function probeWriteScope(config: MixpanelClientConfig): Promise<boolean>;
+declare function fetchSegmentation(config: MixpanelClientConfig, query: MixpanelQuery, signal?: AbortSignal): Promise<unknown>;
+declare function fetchEventNames(config: MixpanelClientConfig): Promise<string[]>;
+declare function executeMixpanelQuery(config: MixpanelClientConfig, opts: SourceAdapterExecuteOpts<MixpanelQuery>): Promise<SourceAdapterExecuteResult<Record<string, unknown>>>;
+
+declare const READ_ONLY_REQUIRED_MSG = "MixpanelAdapter: read-only API token required; got token with write scope";
+/** Maps adapter aggregate to Mixpanel segmentation `type`. */
+declare function aggregateToSegmentationType(aggregate: MixpanelQuery["aggregate"] | undefined): "general" | "unique" | "average";
+declare function buildSegmentationSearchParams(query: MixpanelQuery, projectId: string): URLSearchParams;
+declare function buildSumSearchParams(query: MixpanelQuery, projectId: string): URLSearchParams;
+interface SegmentationSeriesRow {
+    date: string;
+    value: number;
+    event?: string;
+    segment?: string;
+}
+/** Flattens Mixpanel segmentation JSON into tabular rows. */
+declare function parseSegmentationData(data: unknown, eventName?: string): SegmentationSeriesRow[];
+declare function sumRowValues(rows: SegmentationSeriesRow[]): number;
+/** @deprecated Use {@link compileMetricForMixpanel} from `./compile-metric.js`. */
+declare function compileMetricQuery(opts: Parameters<typeof compileMetricForMixpanel>[0]): MixpanelQuery;
+
+export { type MixpanelAdapter, type MixpanelAdapterOptions, type MixpanelClientConfig, type MixpanelEventInfo, type MixpanelQuery, READ_ONLY_REQUIRED_MSG, type SegmentationSeriesRow, aggregateToSegmentationType, basicAuthHeader, buildSegmentationSearchParams, buildSumSearchParams, compileMetricForMixpanel, compileMetricQuery, deriveMixpanelAdapterId, executeMixpanelQuery, fetchEventNames, fetchSegmentation, hashProjectToken, importApiBaseUrl, mixpanelAdapter, parseSegmentationData, probeWriteScope, queryApiBaseUrl, sumRowValues };

package/dist/index.js

@@ -0,0 +1,325 @@
+import { createHash } from 'crypto';
+
+// src/adapter.ts
+
+// src/compile-metric.ts
+function defaultDateRange() {
+  const to = /* @__PURE__ */ new Date();
+  const from = new Date(to);
+  from.setUTCDate(from.getUTCDate() - 30);
+  return {
+    from_date: formatDate(from),
+    to_date: formatDate(to)
+  };
+}
+function formatDate(d) {
+  return d.toISOString().slice(0, 10);
+}
+function compileMetricForMixpanel(opts) {
+  const { entity, metric } = opts;
+  const measure = entity.measures?.find((m) => m.name === metric);
+  if (measure == null) {
+    throw new Error(
+      `compileMetricForMixpanel: metric '${metric}' not found on entity '${entity.name}'`
+    );
+  }
+  const range = defaultDateRange();
+  const sql = measure.sql.toLowerCase();
+  let aggregate = "count";
+  if (sql.includes("sum(")) {
+    aggregate = "sum";
+  } else if (sql.includes("avg(") || sql.includes("average")) {
+    aggregate = "average";
+  }
+  const eventDim = entity.dimensions?.find((d) => d.name === "event_name");
+  const event = typeof opts.filters?.event_name === "string" ? opts.filters.event_name : typeof opts.filters?.event === "string" ? opts.filters.event : eventDim != null ? void 0 : entity.name;
+  const query = {
+    ...range,
+    aggregate,
+    ...event != null ? { event } : {}
+  };
+  if (aggregate === "sum") {
+    const onDim = entity.dimensions?.find((d) => d.name !== "event_name");
+    query.on = onDim?.sql ?? 'properties["$amount"]';
+  }
+  return { query };
+}
+
+// src/query.ts
+var READ_ONLY_REQUIRED_MSG = "MixpanelAdapter: read-only API token required; got token with write scope";
+function aggregateToSegmentationType(aggregate) {
+  switch (aggregate) {
+    case "average":
+      return "average";
+    case "sum":
+      return "general";
+    case "count":
+    default:
+      return "general";
+  }
+}
+function requiresSumEndpoint(query) {
+  return query.aggregate === "sum" && query.on != null && query.on !== "";
+}
+function buildSegmentationSearchParams(query, projectId) {
+  const params = new URLSearchParams();
+  params.set("project_id", projectId);
+  if (query.event) {
+    params.set("event", query.event);
+  }
+  params.set("from_date", query.from_date);
+  params.set("to_date", query.to_date);
+  if (query.where) {
+    params.set("where", query.where);
+  }
+  if (query.on && !requiresSumEndpoint(query)) {
+    params.set("on", query.on);
+  }
+  params.set("type", aggregateToSegmentationType(query.aggregate));
+  return params;
+}
+function buildSumSearchParams(query, projectId) {
+  const params = new URLSearchParams();
+  params.set("project_id", projectId);
+  if (query.event) {
+    params.set("event", query.event);
+  }
+  params.set("fromDate", query.from_date);
+  params.set("toDate", query.to_date);
+  if (query.on) {
+    params.set("on", query.on);
+  }
+  if (query.where) {
+    params.set("where", query.where);
+  }
+  return params;
+}
+function parseSegmentationData(data, eventName) {
+  if (data == null || typeof data !== "object") {
+    return [];
+  }
+  const root = data;
+  if (root.results && typeof root.results === "object") {
+    return Object.entries(root.results).map(([date, value]) => {
+      const row = {
+        date,
+        value: Number(value)
+      };
+      if (eventName != null) {
+        row.event = eventName;
+      }
+      return row;
+    });
+  }
+  const series = root.data?.series ?? [];
+  const values = root.data?.values ?? {};
+  const rows = [];
+  for (const [segment, byDate] of Object.entries(values)) {
+    for (const date of series) {
+      const raw = byDate[date];
+      if (raw == null) {
+        continue;
+      }
+      rows.push({
+        date,
+        value: Number(raw),
+        event: eventName ?? segment,
+        segment
+      });
+    }
+  }
+  if (rows.length === 0 && eventName != null) {
+    const direct = values[eventName];
+    if (direct) {
+      for (const [date, raw] of Object.entries(direct)) {
+        rows.push({ date, value: Number(raw), event: eventName });
+      }
+    }
+  }
+  return rows;
+}
+function sumRowValues(rows) {
+  return rows.reduce((acc, r) => acc + r.value, 0);
+}
+function compileMetricQuery(opts) {
+  return compileMetricForMixpanel(opts).query;
+}
+
+// src/execute.ts
+function queryApiBaseUrl(region = "mixpanel") {
+  return `https://${region}.com/api/query`;
+}
+function importApiBaseUrl(region = "mixpanel") {
+  const host = region === "mixpanel" ? "api.mixpanel.com" : `api.${region}.com`;
+  return `https://${host}`;
+}
+function basicAuthHeader(projectToken) {
+  const encoded = Buffer.from(`${projectToken}:`).toString("base64");
+  return `Basic ${encoded}`;
+}
+async function mixpanelGet(config, path, params, signal) {
+  const url = `${config.queryBaseUrl}${path}?${params.toString()}`;
+  const init = {
+    method: "GET",
+    headers: {
+      Authorization: basicAuthHeader(config.projectToken),
+      Accept: "application/json"
+    }
+  };
+  if (signal != null) {
+    init.signal = signal;
+  }
+  const res = await config.fetch(url, init);
+  const text = await res.text();
+  let body = null;
+  if (text.length > 0) {
+    try {
+      body = JSON.parse(text);
+    } catch {
+      body = { raw: text };
+    }
+  }
+  if (!res.ok) {
+    const detail = body && typeof body === "object" && "error" in body ? String(body.error) : text.slice(0, 200);
+    throw new Error(
+      `Mixpanel Query API ${path} failed (${res.status}): ${detail}`
+    );
+  }
+  return body;
+}
+async function probeWriteScope(config) {
+  const url = `${config.importBaseUrl}/import?strict=1&project_id=${encodeURIComponent(config.projectId)}`;
+  const probeBody = JSON.stringify([
+    {
+      event: "__arivie_readonly_probe__",
+      properties: {
+        distinct_id: "__arivie_probe__",
+        time: Math.floor(Date.now() / 1e3),
+        $insert_id: `arivie-probe-${Date.now()}`
+      }
+    }
+  ]);
+  const res = await config.fetch(url, {
+    method: "POST",
+    headers: {
+      Authorization: basicAuthHeader(config.projectToken),
+      "Content-Type": "application/json"
+    },
+    body: probeBody
+  });
+  if (res.status === 401 || res.status === 403) {
+    return false;
+  }
+  const text = await res.text();
+  if (!res.ok) {
+    return false;
+  }
+  try {
+    const parsed = JSON.parse(text);
+    if (parsed.status === "ok" || parsed.code === 200) {
+      return true;
+    }
+  } catch {
+    if (res.ok) {
+      return true;
+    }
+  }
+  return false;
+}
+async function fetchSegmentation(config, query, signal) {
+  if (requiresSumEndpoint(query)) {
+    const params2 = buildSumSearchParams(query, config.projectId);
+    return mixpanelGet(config, "/segmentation/sum", params2, signal);
+  }
+  const params = buildSegmentationSearchParams(query, config.projectId);
+  return mixpanelGet(config, "/segmentation", params, signal);
+}
+async function fetchEventNames(config) {
+  const params = new URLSearchParams();
+  params.set("project_id", config.projectId);
+  params.set("type", "general");
+  const body = await mixpanelGet(config, "/events/names", params);
+  if (Array.isArray(body)) {
+    return body.filter((x) => typeof x === "string");
+  }
+  return [];
+}
+async function executeMixpanelQuery(config, opts) {
+  const startedAt = Date.now();
+  const controller = new AbortController();
+  const timeout = setTimeout(() => controller.abort(), opts.timeoutMs);
+  try {
+    const raw = await fetchSegmentation(config, opts.query, controller.signal);
+    const parsed = parseSegmentationData(raw, opts.query.event);
+    const rows = parsed.map((r) => ({
+      date: r.date,
+      value: r.value,
+      event: r.event ?? opts.query.event,
+      segment: r.segment
+    }));
+    const truncated = rows.length > opts.rowLimit;
+    const limited = rows.slice(0, opts.rowLimit);
+    return {
+      rows: limited,
+      rowCount: limited.length,
+      durationMs: Date.now() - startedAt,
+      truncated
+    };
+  } finally {
+    clearTimeout(timeout);
+  }
+}
+
+// src/adapter.ts
+function deriveMixpanelAdapterId(projectId, projectToken) {
+  const hash = createHash("sha256").update(projectToken).digest("hex").slice(0, 12);
+  return `mixpanel:${projectId}:${hash}`;
+}
+function hashProjectToken(projectToken) {
+  return createHash("sha256").update(projectToken).digest("hex").slice(0, 12);
+}
+function mixpanelAdapter(opts) {
+  const region = opts.region ?? "mixpanel";
+  const projectId = String(opts.projectId);
+  const clientConfig = {
+    projectToken: opts.projectToken,
+    projectId,
+    queryBaseUrl: queryApiBaseUrl(region),
+    importBaseUrl: importApiBaseUrl(region),
+    fetch: opts.fetch ?? globalThis.fetch
+  };
+  let introspectCache = null;
+  let readOnlyVerified = opts.skipReadOnlyProbe === true;
+  async function ensureReadOnly() {
+    if (readOnlyVerified) {
+      return;
+    }
+    const writable = await probeWriteScope(clientConfig);
+    readOnlyVerified = true;
+    if (writable) {
+      throw new Error(READ_ONLY_REQUIRED_MSG);
+    }
+  }
+  return {
+    kind: "mixpanel",
+    id: deriveMixpanelAdapterId(projectId, opts.projectToken),
+    async execute(executeOpts) {
+      await ensureReadOnly();
+      return executeMixpanelQuery(clientConfig, executeOpts);
+    },
+    async introspect() {
+      if (introspectCache != null) {
+        return introspectCache;
+      }
+      await ensureReadOnly();
+      const names = await fetchEventNames(clientConfig);
+      introspectCache = names.map((name) => ({ name }));
+      return introspectCache;
+    },
+    async verifyOwnerIdentity() {
+    },
+    compileMetric: compileMetricForMixpanel
+  };
+}
+
+export { READ_ONLY_REQUIRED_MSG, aggregateToSegmentationType, basicAuthHeader, buildSegmentationSearchParams, buildSumSearchParams, compileMetricForMixpanel, compileMetricQuery, deriveMixpanelAdapterId, executeMixpanelQuery, fetchEventNames, fetchSegmentation, hashProjectToken, importApiBaseUrl, mixpanelAdapter, parseSegmentationData, probeWriteScope, queryApiBaseUrl, sumRowValues };

package/package.json

@@ -0,0 +1,41 @@
+{
+  "name": "@arivie/source-mixpanel",
+  "version": "0.1.0",
+  "description": "Arivie Mixpanel source adapter — Query API segmentation with read-only token enforcement.",
+  "type": "module",
+  "license": "Apache-2.0",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "dependencies": {
+    "@arivie/core": "0.1.0",
+    "@arivie/semantic": "0.1.0"
+  },
+  "devDependencies": {
+    "@types/node": "^22.0.0",
+    "tsup": "^8.5.1",
+    "typescript": "^6.0.0",
+    "vitest": "^4.1.0"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "scripts": {
+    "build": "tsup",
+    "test": "vitest run",
+    "typecheck": "tsc --noEmit",
+    "lint": "echo no-lint-yet"
+  }
+}