@voltro/plugin-tinybird 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,41 @@
+import { AggregateQuery } from '@voltro/runtime';
+import { AnalyticsBucket } from '@voltro/runtime';
+import { AnalyticsEvent } from '@voltro/runtime';
+import { AnalyticsSinkSpec } from '@voltro/runtime';
+import { AnalyticsTopEntry } from '@voltro/runtime';
+import { TimeseriesQuery } from '@voltro/runtime';
+import { TopNQuery } from '@voltro/runtime';
+
+export { AggregateQuery }
+
+export { AnalyticsBucket }
+
+export { AnalyticsEvent }
+
+export { AnalyticsTopEntry }
+
+export { TimeseriesQuery }
+
+export declare const tinybirdAnalytics: (options: TinybirdAnalyticsOptions) => AnalyticsSinkSpec;
+
+export declare interface TinybirdAnalyticsOptions {
+    readonly token: string;
+    /** Tinybird region: 'eu' | 'us-east' | 'us-west' | 'asia-southeast' / custom URL. */
+    readonly region?: string;
+    /** Custom API base URL (overrides `region`). Useful for self-hosted Tinybird or
+     *  preview environments. */
+    readonly apiUrl?: string;
+    /** Datasource name. The plugin POSTs events to /v0/events?name=<datasource>.
+     *  Default: 'voltro_events'. */
+    readonly datasource?: string;
+    /** Override pipe names. Defaults to the three canonical pipes. */
+    readonly pipes?: {
+        readonly aggregate?: string;
+        readonly timeseries?: string;
+        readonly topN?: string;
+    };
+}
+
+export { TopNQuery }
+
+export { }

package/dist/index.js

@@ -0,0 +1,157 @@
+import { Effect as e } from "effect";
+import { AnalyticsError as t } from "@voltro/runtime";
+//#region src/sink.ts
+var n = "tinybird", r = (r) => e.mapError((e) => new t({
+	provider: n,
+	operation: r,
+	cause: e instanceof Error ? `${e.name}: ${e.message}` : String(e)
+})), i = /^[A-Za-z_][A-Za-z0-9_]*$/, a = (e, r) => {
+	if (!i.test(e)) throw new t({
+		provider: n,
+		operation: "config",
+		cause: `invalid ${r} ${JSON.stringify(e)} — must match ${i.source} (letters, digits, underscore; no dots/slashes/quotes/spaces)`
+	});
+	return e;
+}, o = /['\\]/, s = (e) => {
+	for (let t = 0; t < e.length; t++) if (e.charCodeAt(t) < 32) return !0;
+	return !1;
+}, c = (e) => {
+	if (o.test(e) || s(e)) throw Error(`tinybird: invalid property key ${JSON.stringify(e)} — must not contain quotes, backslashes, or control characters`);
+	return e;
+}, l = (e, t) => {
+	let n = [];
+	if (t != null && n.push(`tenant_id = '${t.replace(/'/g, "''")}'`), e) for (let [t, r] of Object.entries(e)) {
+		let e = String(r).replace(/'/g, "''");
+		n.push(`JSONExtractString(properties, '${c(t)}') = '${e}'`);
+	}
+	return n.length === 0 ? "" : ` AND ${n.join(" AND ")}`;
+}, u = (e) => e === "count" ? "count()" : e === "unique" ? "uniqExact(subject_id)" : "sum" in e ? `sum(JSONExtractFloat(properties, '${c(e.sum)}'))` : `avg(JSONExtractFloat(properties, '${c(e.avg)}'))`, d = async (e, t, n) => {
+	let r = new URL(`${e.apiUrl}/v0/pipes/${t}.json`);
+	for (let [e, t] of Object.entries(n)) r.searchParams.set(e, String(t));
+	let i = await fetch(r.toString(), { headers: { authorization: `Bearer ${e.token}` } });
+	if (!i.ok) {
+		let e = await i.text().catch(() => "");
+		throw Error(`tinybird pipe ${t} returned HTTP ${i.status}: ${e}`);
+	}
+	return i.json();
+}, f = (t) => ({
+	info: {
+		provider: n,
+		capabilities: {
+			track: !0,
+			aggregate: !0,
+			timeseries: !0,
+			topN: !0,
+			mirror: !1
+		},
+		detail: {
+			apiUrl: t.apiUrl,
+			datasource: t.datasource,
+			pipes: t.pipes
+		}
+	},
+	track: (n) => e.gen(function* () {
+		let r = `${t.apiUrl}/v0/events?name=${encodeURIComponent(t.datasource)}`, i = JSON.stringify({
+			name: n.name,
+			subject_id: n.subjectId ?? null,
+			tenant_id: n.tenantId ?? null,
+			properties: JSON.stringify(n.properties),
+			occurred_at: (n.occurredAt ?? /* @__PURE__ */ new Date()).toISOString()
+		}), a = yield* e.tryPromise({
+			try: () => fetch(r, {
+				method: "POST",
+				headers: {
+					authorization: `Bearer ${t.token}`,
+					"content-type": "application/json"
+				},
+				body: i
+			}),
+			catch: (e) => e
+		});
+		if (!a.ok) {
+			let t = yield* e.tryPromise({
+				try: () => a.text(),
+				catch: () => "no body"
+			});
+			return yield* e.fail(/* @__PURE__ */ Error(`tinybird events API returned HTTP ${a.status}: ${t}`));
+		}
+	}).pipe(r("track")),
+	aggregate: (n) => e.gen(function* () {
+		let { data: r } = yield* e.tryPromise({
+			try: () => d(t, t.pipes.aggregate, {
+				event: n.event,
+				from: n.range.from.toISOString(),
+				to: (n.range.to ?? /* @__PURE__ */ new Date()).toISOString(),
+				metric_expr: u(n.metric),
+				filter_sql: l(n.filter, n.tenantId)
+			}),
+			catch: (e) => e
+		}), i = r[0]?.value ?? 0;
+		return typeof i == "number" ? i : Number(i ?? 0);
+	}).pipe(r("aggregate")),
+	timeseries: (n) => e.gen(function* () {
+		let { data: r } = yield* e.tryPromise({
+			try: () => d(t, t.pipes.timeseries, {
+				event: n.event,
+				from: n.range.from.toISOString(),
+				to: (n.range.to ?? /* @__PURE__ */ new Date()).toISOString(),
+				metric_expr: u(n.metric),
+				filter_sql: l(n.filter, n.tenantId),
+				bucket_fn: p(n.bucket)
+			}),
+			catch: (e) => e
+		});
+		return r.map((e) => ({
+			bucketStart: new Date(e.bucket_start),
+			value: typeof e.value == "number" ? e.value : Number(e.value ?? 0)
+		}));
+	}).pipe(r("timeseries")),
+	topN: (n) => e.gen(function* () {
+		let { data: r } = yield* e.tryPromise({
+			try: () => d(t, t.pipes.topN, {
+				event: n.event,
+				from: n.range.from.toISOString(),
+				to: (n.range.to ?? /* @__PURE__ */ new Date()).toISOString(),
+				group_expr: `JSONExtractString(properties, '${c(n.groupBy)}')`,
+				metric_expr: n.metric === "count" ? "count()" : `sum(JSONExtractFloat(properties, '${c(n.metric.sum)}'))`,
+				filter_sql: l(n.filter, n.tenantId),
+				limit: Math.max(1, Math.floor(n.n))
+			}),
+			catch: (e) => e
+		});
+		return r.filter((e) => e.key !== null).map((e) => ({
+			key: e.key,
+			value: typeof e.value == "number" ? e.value : Number(e.value ?? 0)
+		}));
+	}).pipe(r("topN"))
+}), p = (e) => {
+	switch (e) {
+		case "minute": return "toStartOfMinute";
+		case "hour": return "toStartOfHour";
+		case "day": return "toStartOfDay";
+		case "week": return "toStartOfWeek";
+		case "month": return "toStartOfMonth";
+	}
+}, m = {
+	eu: "https://api.tinybird.co",
+	"us-east": "https://api.us-east.tinybird.co",
+	"us-west": "https://api.us-west.tinybird.co",
+	"asia-southeast": "https://api.tinybird.co"
+}, h = (e) => {
+	let t = e.apiUrl ?? m[e.region ?? "eu"] ?? "https://api.tinybird.co", n = {
+		token: e.token,
+		apiUrl: t,
+		datasource: a(e.datasource ?? "voltro_events", "datasource"),
+		pipes: {
+			aggregate: a(e.pipes?.aggregate ?? "events_aggregate", "aggregate pipe name"),
+			timeseries: a(e.pipes?.timeseries ?? "events_timeseries", "timeseries pipe name"),
+			topN: a(e.pipes?.topN ?? "events_topn", "topN pipe name")
+		}
+	};
+	return {
+		kind: "tinybird",
+		build: (e) => f(n)
+	};
+};
+//#endregion
+export { h as tinybirdAnalytics };

package/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "@voltro/plugin-tinybird",
+  "version": "0.1.0",
+  "description": "Tinybird AnalyticsSink. Hosted ClickHouse with the Tinybird Events API + Pipes for low-friction OLAP. Pay-as-you-go alternative to running your own ClickHouse.",
+  "keywords": [
+    "voltro",
+    "typescript",
+    "framework"
+  ],
+  "license": "SEE LICENSE IN LICENSE",
+  "homepage": "https://voltro.dev",
+  "bugs": {
+    "email": "support@voltro.dev"
+  },
+  "author": {
+    "name": "Voltro UG",
+    "url": "https://voltro.dev"
+  },
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    }
+  },
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "sideEffects": false,
+  "engines": {
+    "node": ">=24.0.0"
+  },
+  "dependencies": {
+    "@voltro/runtime": "0.1.0"
+  },
+  "peerDependencies": {
+    "effect": "^3.21.4"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}