@useairfoil/producer-google-analytics 0.0.1 → 0.0.2

package/dist/index.mjs

@@ -0,0 +1,3 @@
+import { a as DeviceSchema, c as LandingPageSchema, d as TrafficSourceSchema, f as UserAcquisitionSchema, i as DailyOverviewSchema, l as LocationSchema, m as auth_exports, n as connector_exports, o as EcommerceItemSchema, p as client_exports, s as EventSchema, u as PageSchema } from "./src-Cu0LuOTi.mjs";
+import { manifest } from "./manifest.mjs";
+export { DailyOverviewSchema, DeviceSchema, EcommerceItemSchema, EventSchema, auth_exports as GoogleAnalyticsAuth, client_exports as GoogleAnalyticsClient, connector_exports as GoogleAnalyticsConnector, LandingPageSchema, LocationSchema, PageSchema, TrafficSourceSchema, UserAcquisitionSchema, manifest };

package/dist/main.d.mts

@@ -0,0 +1 @@
+export {}

package/dist/main.mjs

@@ -0,0 +1,662 @@
+#!/usr/bin/env node
+import { a as DeviceSchema, c as LandingPageSchema, d as TrafficSourceSchema, f as UserAcquisitionSchema, i as DailyOverviewSchema, l as LocationSchema, o as EcommerceItemSchema, r as layerConfig, s as EventSchema, t as GoogleAnalyticsConnector, u as PageSchema } from "./src-Cu0LuOTi.mjs";
+import { GoogleAnalyticsConfigDef } from "./manifest.mjs";
+import { ConnectorApp, Demo, Ingestor, RuntimeConfig, StateStore, Telemetry } from "@useairfoil/connector-kit";
+import { Config, DateTime, Duration, Effect, Layer, Logger, Schema } from "effect";
+import { FetchHttpClient } from "effect/http";
+import { NodeRuntime, NodeServices } from "@effect/platform-node";
+import { Command } from "effect/cli";
+import { PgClient } from "@effect/sql-pg";
+//#region package.json
+var version = "0.0.1";
+//#endregion
+//#region src/tables.ts
+const tableSchemas = {
+	daily_overview: DailyOverviewSchema,
+	traffic_sources: TrafficSourceSchema,
+	user_acquisition: UserAcquisitionSchema,
+	pages: PageSchema,
+	landing_pages: LandingPageSchema,
+	events: EventSchema,
+	locations: LocationSchema,
+	devices: DeviceSchema,
+	ecommerce_items: EcommerceItemSchema
+};
+//#endregion
+//#region src/create-table.ts
+const createTableCommand = ConnectorApp.makeCreateTableCommand(tableSchemas);
+//#endregion
+//#region src/demo/shared.ts
+const day = Duration.toMillis(Duration.days(1));
+const propertyId = "123456789";
+const host = "shop.acme.example.com";
+const sources = [
+	[
+		"google",
+		"organic",
+		"(organic)",
+		"Organic Search",
+		34
+	],
+	[
+		"(direct)",
+		"(none)",
+		"(direct)",
+		"Direct",
+		22
+	],
+	[
+		"google",
+		"cpc",
+		"brand_search",
+		"Paid Search",
+		14
+	],
+	[
+		"facebook",
+		"paid_social",
+		"fall_sale",
+		"Paid Social",
+		9
+	],
+	[
+		"newsletter",
+		"email",
+		"weekly_digest",
+		"Email",
+		8
+	],
+	[
+		"bing",
+		"organic",
+		"(organic)",
+		"Organic Search",
+		5
+	],
+	[
+		"instagram.com",
+		"referral",
+		"(referral)",
+		"Organic Social",
+		5
+	],
+	[
+		"partner.example.com",
+		"referral",
+		"(referral)",
+		"Referral",
+		3
+	]
+];
+const pages = [
+	[
+		"/",
+		"Acme - Everyday goods",
+		30
+	],
+	[
+		"/collections/new",
+		"New arrivals - Acme",
+		14
+	],
+	[
+		"/collections/sale",
+		"Sale - Acme",
+		12
+	],
+	[
+		"/products/classic-tee",
+		"Classic Tee - Acme",
+		9
+	],
+	[
+		"/products/everyday-hoodie",
+		"Everyday Hoodie - Acme",
+		8
+	],
+	[
+		"/products/water-bottle",
+		"Insulated Water Bottle - Acme",
+		6
+	],
+	[
+		"/cart",
+		"Your cart - Acme",
+		8
+	],
+	[
+		"/checkout",
+		"Checkout - Acme",
+		5
+	],
+	[
+		"/blog/how-we-source-cotton",
+		"How we source our cotton - Acme",
+		4
+	],
+	[
+		"/pages/shipping",
+		"Shipping - Acme",
+		4
+	]
+];
+const locations = [
+	[
+		"United States",
+		"California",
+		"Los Angeles",
+		14
+	],
+	[
+		"United States",
+		"New York",
+		"New York",
+		12
+	],
+	[
+		"United States",
+		"Texas",
+		"Austin",
+		7
+	],
+	[
+		"United States",
+		"Illinois",
+		"Chicago",
+		6
+	],
+	[
+		"United Kingdom",
+		"England",
+		"London",
+		9
+	],
+	[
+		"Canada",
+		"Ontario",
+		"Toronto",
+		6
+	],
+	[
+		"Germany",
+		"Berlin",
+		"Berlin",
+		5
+	],
+	[
+		"Australia",
+		"New South Wales",
+		"Sydney",
+		4
+	],
+	[
+		"United States",
+		"(not set)",
+		"(not set)",
+		3
+	]
+];
+const devices = [
+	[
+		"mobile",
+		"web",
+		"iOS",
+		"Safari",
+		30
+	],
+	[
+		"mobile",
+		"web",
+		"Android",
+		"Chrome",
+		22
+	],
+	[
+		"desktop",
+		"web",
+		"Windows",
+		"Chrome",
+		18
+	],
+	[
+		"desktop",
+		"web",
+		"Macintosh",
+		"Chrome",
+		12
+	],
+	[
+		"desktop",
+		"web",
+		"Macintosh",
+		"Safari",
+		10
+	],
+	[
+		"tablet",
+		"web",
+		"iOS",
+		"Safari",
+		5
+	],
+	[
+		"desktop",
+		"web",
+		"Windows",
+		"Edge",
+		3
+	]
+];
+const items = [
+	[
+		"SKU-TEE",
+		"Classic Cotton Tee",
+		"Apparel",
+		28
+	],
+	[
+		"SKU-HOODIE",
+		"Everyday Hoodie",
+		"Apparel",
+		64
+	],
+	[
+		"SKU-SHIRT",
+		"Linen Button Shirt",
+		"Apparel",
+		72
+	],
+	[
+		"SKU-BEANIE",
+		"Wool Beanie",
+		"Accessories",
+		26
+	],
+	[
+		"SKU-TOTE",
+		"Canvas Tote Bag",
+		"Accessories",
+		22
+	],
+	[
+		"SKU-MUG",
+		"Stoneware Mug",
+		"Home",
+		18
+	],
+	[
+		"SKU-BOTTLE",
+		"Insulated Water Bottle",
+		"Home",
+		32
+	]
+];
+/** Splits a total by weights into whole numbers that add up to it. */
+const split = (total, weights) => {
+	const sum = weights.reduce((a, b) => a + b, 0);
+	const parts = weights.map((weight) => Math.floor(total * weight / sum));
+	parts[0] = (parts[0] ?? 0) + total - parts.reduce((a, b) => a + b, 0);
+	return parts;
+};
+const money = (value) => Math.round(value * 100) / 100;
+//#endregion
+//#region src/demo/reports.ts
+/** One group is one day of reports, counting back from yesterday. */
+const dayRows = (index, { faker, now }) => {
+	const date = DateTime.formatIsoDateUtc(DateTime.fromDateUnsafe(new Date(now.getTime() - (index + 1) * day)));
+	const id = (...dimensions) => JSON.stringify([
+		propertyId,
+		date,
+		...dimensions
+	]);
+	const base = {
+		version: now,
+		property_id: propertyId,
+		date
+	};
+	const weekday = (/* @__PURE__ */ new Date(`${date}T00:00:00Z`)).getUTCDay();
+	const weekend = weekday === 0 || weekday === 6 ? .75 : 1;
+	const growth = Math.max(.4, 1 - index / 900);
+	const sessions = Math.round(4200 * weekend * growth * faker.number.float({
+		min: .85,
+		max: 1.15
+	}));
+	const engaged = Math.round(sessions * faker.number.float({
+		min: .55,
+		max: .68
+	}));
+	const activeUsers = Math.round(sessions * .78);
+	const newUsers = Math.round(activeUsers * faker.number.float({
+		min: .42,
+		max: .55
+	}));
+	const views = Math.round(sessions * faker.number.float({
+		min: 3.2,
+		max: 4.4
+	}));
+	const purchases = Math.round(sessions * faker.number.float({
+		min: .018,
+		max: .028
+	}));
+	const revenue = money(purchases * faker.number.float({
+		min: 58,
+		max: 74
+	}));
+	const engagement = money(engaged * faker.number.float({
+		min: 95,
+		max: 140
+	}));
+	const bySource = split(sessions, sources.map((source) => source[4]));
+	const byNewSource = split(newUsers, sources.map((source) => source[4]));
+	const purchasesBySource = split(purchases, sources.map((source) => source[4]));
+	const share = (part, whole) => whole === 0 ? 0 : part / whole;
+	const eventCounts = [
+		[
+			"page_view",
+			views,
+			activeUsers
+		],
+		[
+			"session_start",
+			sessions,
+			activeUsers
+		],
+		[
+			"first_visit",
+			newUsers,
+			newUsers
+		],
+		[
+			"user_engagement",
+			engaged * 3,
+			Math.round(activeUsers * .7)
+		],
+		[
+			"scroll",
+			Math.round(views * .45),
+			Math.round(activeUsers * .5)
+		],
+		[
+			"view_item",
+			Math.round(views * .3),
+			Math.round(activeUsers * .4)
+		],
+		[
+			"add_to_cart",
+			Math.round(sessions * .08),
+			Math.round(activeUsers * .07)
+		],
+		[
+			"begin_checkout",
+			Math.round(sessions * .04),
+			Math.round(activeUsers * .035)
+		],
+		[
+			"purchase",
+			purchases,
+			purchases
+		]
+	];
+	const itemUnits = split(purchases + Math.round(purchases * .4), items.map((item) => 10 - item[3] / 10));
+	const viewsByPage = split(views, pages.map((page) => page[2]));
+	const sessionsByLanding = split(sessions, [
+		42,
+		16,
+		14,
+		10,
+		10,
+		8
+	]);
+	const sessionsByLocation = split(sessions, locations.map((location) => location[3]));
+	const sessionsByDevice = split(sessions, devices.map((device) => device[4]));
+	return {
+		daily_overview: [{
+			id: id(),
+			...base,
+			active_users: BigInt(activeUsers),
+			new_users: BigInt(newUsers),
+			total_users: BigInt(Math.round(activeUsers * 1.08)),
+			sessions: BigInt(sessions),
+			engaged_sessions: BigInt(engaged),
+			screen_page_views: BigInt(views),
+			event_count: BigInt(eventCounts.reduce((sum, [, count]) => sum + count, 0)),
+			key_events: purchases,
+			total_revenue: revenue,
+			user_engagement_duration: engagement,
+			currency_code: "USD"
+		}],
+		traffic_sources: sources.map(([source, medium, campaign, channel], s) => {
+			const part = bySource[s] ?? 0;
+			return {
+				id: id(source, medium, campaign, channel),
+				...base,
+				session_source: source,
+				session_medium: medium,
+				session_campaign_name: campaign,
+				session_default_channel_group: channel,
+				sessions: BigInt(part),
+				engaged_sessions: BigInt(Math.round(part * share(engaged, sessions))),
+				active_users: BigInt(Math.round(part * share(activeUsers, sessions))),
+				new_users: BigInt(Math.round(part * share(newUsers, sessions))),
+				screen_page_views: BigInt(Math.round(part * share(views, sessions))),
+				event_count: BigInt(Math.round(part * share(views, sessions) * 2.6)),
+				key_events: purchasesBySource[s] ?? 0,
+				total_revenue: money(revenue * share(purchasesBySource[s] ?? 0, purchases)),
+				user_engagement_duration: money(engagement * share(part, sessions)),
+				currency_code: "USD"
+			};
+		}),
+		user_acquisition: sources.map(([source, medium, campaign, channel], s) => ({
+			id: id(source, medium, campaign, channel),
+			...base,
+			first_user_source: source,
+			first_user_medium: medium,
+			first_user_campaign_name: campaign,
+			first_user_default_channel_group: channel,
+			new_users: BigInt(byNewSource[s] ?? 0),
+			active_users: BigInt(Math.round((byNewSource[s] ?? 0) * 1.6)),
+			sessions: BigInt(Math.round((byNewSource[s] ?? 0) * 1.9)),
+			engaged_sessions: BigInt(Math.round((byNewSource[s] ?? 0) * 1.1)),
+			key_events: Math.round((purchasesBySource[s] ?? 0) * .4),
+			total_revenue: money(revenue * .4 * share(purchasesBySource[s] ?? 0, purchases)),
+			currency_code: "USD"
+		})),
+		pages: pages.map(([path, title, weight], p) => {
+			const part = viewsByPage[p] ?? 0;
+			return {
+				id: id(host, path, title),
+				...base,
+				host_name: host,
+				page_path: path,
+				page_title: title,
+				screen_page_views: BigInt(part),
+				active_users: BigInt(Math.round(part * .62)),
+				event_count: BigInt(Math.round(part * 2.4)),
+				key_events: path === "/checkout" ? purchases : 0,
+				user_engagement_duration: money(engagement * (weight / 100))
+			};
+		}),
+		landing_pages: pages.slice(0, 6).map(([path], l) => {
+			const part = sessionsByLanding[l] ?? 0;
+			return {
+				id: id(path),
+				...base,
+				landing_page: path,
+				sessions: BigInt(part),
+				engaged_sessions: BigInt(Math.round(part * share(engaged, sessions))),
+				active_users: BigInt(Math.round(part * .8)),
+				new_users: BigInt(Math.round(part * share(newUsers, sessions))),
+				key_events: Math.round(purchases * share(part, sessions)),
+				total_revenue: money(revenue * share(part, sessions)),
+				currency_code: "USD"
+			};
+		}),
+		events: eventCounts.map(([name, count, users]) => ({
+			id: id(name),
+			...base,
+			event_name: name,
+			event_count: BigInt(count),
+			total_users: BigInt(users),
+			event_value: name === "purchase" ? revenue : 0,
+			key_events: name === "purchase" ? purchases : 0
+		})),
+		locations: locations.map(([country, region, city], l) => {
+			const part = sessionsByLocation[l] ?? 0;
+			return {
+				id: id(country, region, city),
+				...base,
+				country,
+				region,
+				city,
+				active_users: BigInt(Math.round(part * .78)),
+				new_users: BigInt(Math.round(part * share(newUsers, sessions))),
+				sessions: BigInt(part),
+				engaged_sessions: BigInt(Math.round(part * share(engaged, sessions))),
+				key_events: Math.round(purchases * share(part, sessions)),
+				total_revenue: money(revenue * share(part, sessions)),
+				currency_code: "USD"
+			};
+		}),
+		devices: devices.map(([category, platform, os, browser], d) => {
+			const part = sessionsByDevice[d] ?? 0;
+			return {
+				id: id(category, platform, os, browser),
+				...base,
+				device_category: category,
+				platform,
+				operating_system: os,
+				browser,
+				active_users: BigInt(Math.round(part * .78)),
+				new_users: BigInt(Math.round(part * share(newUsers, sessions))),
+				sessions: BigInt(part),
+				engaged_sessions: BigInt(Math.round(part * share(engaged, sessions))),
+				screen_page_views: BigInt(Math.round(part * share(views, sessions))),
+				key_events: Math.round(purchases * share(part, sessions))
+			};
+		}),
+		ecommerce_items: items.map(([itemId, name, category, price], i) => {
+			const bought = itemUnits[i] ?? 0;
+			const added = Math.round(bought * faker.number.float({
+				min: 3,
+				max: 5
+			}));
+			return {
+				id: id(itemId, name, "Acme", category),
+				...base,
+				item_id: itemId,
+				item_name: name,
+				item_brand: "Acme",
+				item_category: category,
+				items_viewed: BigInt(Math.round(added * faker.number.float({
+					min: 6,
+					max: 9
+				}))),
+				items_added_to_cart: BigInt(added),
+				items_purchased: BigInt(bought),
+				item_revenue: money(bought * price),
+				currency_code: "USD"
+			};
+		})
+	};
+};
+//#endregion
+//#region src/demo/index.ts
+const demo = Demo.define({
+	name: "producer-google-analytics",
+	setup: {
+		tables: [],
+		rows: () => ({})
+	},
+	group: {
+		tables: [
+			Demo.table({
+				name: "daily_overview",
+				rowSchema: DailyOverviewSchema,
+				version: "version"
+			}),
+			Demo.table({
+				name: "traffic_sources",
+				rowSchema: TrafficSourceSchema,
+				version: "version"
+			}),
+			Demo.table({
+				name: "user_acquisition",
+				rowSchema: UserAcquisitionSchema,
+				version: "version"
+			}),
+			Demo.table({
+				name: "pages",
+				rowSchema: PageSchema,
+				version: "version"
+			}),
+			Demo.table({
+				name: "landing_pages",
+				rowSchema: LandingPageSchema,
+				version: "version"
+			}),
+			Demo.table({
+				name: "events",
+				rowSchema: EventSchema,
+				version: "version"
+			}),
+			Demo.table({
+				name: "locations",
+				rowSchema: LocationSchema,
+				version: "version"
+			}),
+			Demo.table({
+				name: "devices",
+				rowSchema: DeviceSchema,
+				version: "version"
+			}),
+			Demo.table({
+				name: "ecommerce_items",
+				rowSchema: EcommerceItemSchema,
+				version: "version"
+			})
+		],
+		rows: dayRows,
+		count: 730
+	}
+});
+const demoCommand = ConnectorApp.makeDemoCommand(demo).pipe(Command.provide(RuntimeConfig.layerHosted()));
+//#endregion
+//#region src/sandbox.ts
+const ConnectorLayer$1 = layerConfig(GoogleAnalyticsConfigDef.config);
+const TelemetryLayer$1 = Layer.mergeAll(Telemetry.layerOtlp(), Telemetry.layerMetricsConsoleDump());
+const sandboxCommand = Command.make("sandbox", {}, () => Effect.gen(function* () {
+	const port = yield* RuntimeConfig.httpPort;
+	const entrypoint = yield* GoogleAnalyticsConnector;
+	return yield* ConnectorApp.start(entrypoint, { port });
+}).pipe(Effect.annotateLogs({ component: "google-analytics" }), Effect.provide(Layer.mergeAll(StateStore.layerMemory, Ingestor.layerConsole, ConnectorLayer$1, Logger.layer([Logger.consolePretty()]), TelemetryLayer$1)))).pipe(Command.withDescription("Run the connector locally and log ingested data"));
+//#endregion
+//#region src/start.ts
+const ConnectorLayer = layerConfig(GoogleAnalyticsConfigDef.config);
+const TelemetryLayer = Telemetry.layerOtlp();
+const PostgresLayer = PgClient.layerConfig({
+	url: Config.schema(Schema.Redacted(Schema.NonEmptyString), RuntimeConfig.PlatformRuntimeKey.postgresConnectionString),
+	maxConnections: Config.succeed(2),
+	connectTimeout: Config.succeed("5 seconds"),
+	applicationName: Config.succeed("airfoil-producer-google-analytics")
+});
+const StateStoreLayer = StateStore.layerSql().pipe(Layer.provide(PostgresLayer));
+const startCommand = Command.make("start", {}, () => Effect.gen(function* () {
+	const port = yield* RuntimeConfig.httpPort;
+	const entrypoint = yield* GoogleAnalyticsConnector;
+	return yield* ConnectorApp.start(entrypoint, { port }).pipe(Effect.provide(Ingestor.layerWingsConfig(entrypoint)));
+}).pipe(Effect.annotateLogs({ component: "google-analytics" }), Effect.provide(Layer.mergeAll(StateStoreLayer, ConnectorLayer, Logger.layer([Logger.consolePretty()]), TelemetryLayer)), Effect.provide(RuntimeConfig.layerHosted()))).pipe(Command.withDescription("Run the production connector against Wings"));
+//#endregion
+//#region src/main.ts
+const BootstrapLayer = Layer.mergeAll(FetchHttpClient.layer, NodeServices.layer);
+const program = Command.make("producer-google-analytics", {}, () => Effect.void).pipe(Command.withSubcommands([
+	startCommand,
+	sandboxCommand,
+	createTableCommand,
+	demoCommand
+]));
+const cli = Command.run(program, { version });
+NodeRuntime.runMain(cli.pipe(Effect.provide(BootstrapLayer), Effect.scoped));
+//#endregion
+export {};
+
+//# sourceMappingURL=main.mjs.map