@gscdump/engine-sqlite 0.4.0

package/dist/index.mjs

@@ -0,0 +1,141 @@
+import { assertSchemaInSync, compileSqlite, compileSqlite as compileSqlite$1, createResolverAdapter, createSqlQuerySource } from "@gscdump/engine/resolver";
+import { and, eq, gte, lte, sql, sql as sql$1 } from "drizzle-orm";
+import { integer, real, sqliteTable, text } from "drizzle-orm/sqlite-core";
+import { createScopedHelpers } from "@gscdump/engine/scope";
+import { drizzle } from "drizzle-orm/sqlite-proxy";
+import { resolveWindow } from "@gscdump/analysis/period";
+function metricCols() {
+	return {
+		clicks: integer("clicks").notNull().default(0),
+		impressions: integer("impressions").notNull().default(0),
+		ctr: real("ctr").notNull().default(0),
+		position: real("position").notNull().default(0),
+		sum_position: real("sum_position").notNull().default(0)
+	};
+}
+function baseCols() {
+	return {
+		id: text("id").primaryKey(),
+		site_id: text("site_id").notNull(),
+		date: text("date").notNull(),
+		created_at: integer("created_at").default(sql$1`(unixepoch())`)
+	};
+}
+const gsc_pages = sqliteTable("gsc_pages", {
+	...baseCols(),
+	url: text("url").notNull(),
+	...metricCols()
+});
+const gsc_keywords = sqliteTable("gsc_keywords", {
+	...baseCols(),
+	query: text("query").notNull(),
+	query_canonical: text("query_canonical"),
+	...metricCols()
+});
+const gsc_countries = sqliteTable("gsc_countries", {
+	...baseCols(),
+	country: text("country").notNull(),
+	...metricCols()
+});
+const gsc_devices = sqliteTable("gsc_devices", {
+	...baseCols(),
+	device: text("device").notNull(),
+	...metricCols()
+});
+const gsc_page_keywords = sqliteTable("gsc_page_keywords", {
+	...baseCols(),
+	url: text("url").notNull(),
+	query: text("query").notNull(),
+	query_canonical: text("query_canonical"),
+	...metricCols()
+});
+const schema = {
+	gsc_pages,
+	gsc_keywords,
+	gsc_countries,
+	gsc_devices,
+	gsc_page_keywords,
+	gsc_search_appearance: sqliteTable("gsc_search_appearance", {
+		...baseCols(),
+		searchAppearance: text("searchAppearance").notNull(),
+		...metricCols()
+	})
+};
+const GSC_PREFIX_RE = /^gsc_/;
+assertSchemaInSync({
+	label: "sqlite",
+	schema,
+	tableKeyToName: (key) => key.replace(GSC_PREFIX_RE, ""),
+	mode: "superset"
+});
+function createSqliteResolverAdapter(options = {}) {
+	return createResolverAdapter({
+		schema,
+		datasetToTableKey: {
+			pages: "gsc_pages",
+			keywords: "gsc_keywords",
+			page_keywords: "gsc_page_keywords",
+			countries: "gsc_countries",
+			devices: "gsc_devices",
+			search_appearance: "gsc_search_appearance"
+		},
+		metricCast: "REAL",
+		regexPredicate: (expr, pattern, negate) => negate ? sql$1`NOT (${expr} REGEXP ${pattern})` : sql$1`${expr} REGEXP ${pattern}`,
+		tableLabel: "sqlite/resolver-adapter",
+		includeSiteId: true,
+		compile: compileSqlite$1,
+		capabilities: {
+			regex: options.regex ?? false,
+			comparisonJoin: true,
+			windowTotals: true
+		}
+	});
+}
+const sqliteResolverAdapter = createSqliteResolverAdapter();
+async function probeSqliteRegex(executor) {
+	return executor(`SELECT 'a' REGEXP 'a' AS r`, [], "all").then(({ rows }) => rows.length > 0).catch(() => false);
+}
+async function createSqliteResolverAdapterFromExecutor(options) {
+	return createSqliteResolverAdapter({ regex: await probeSqliteRegex(options.executor) });
+}
+function createEngine(config) {
+	const { executor, siteId, regex } = config;
+	return createSqlQuerySource({
+		name: "sqlite",
+		adapter: regex === void 0 ? sqliteResolverAdapter : createSqliteResolverAdapter({ regex }),
+		execute: async (sql, params) => {
+			return (await executor(sql, params, "all")).rows;
+		},
+		siteId
+	});
+}
+function aggClicks(t) {
+	return sql$1`SUM(${t.clicks})`;
+}
+function aggImpressions(t) {
+	return sql$1`SUM(${t.impressions})`;
+}
+function aggCtr(t) {
+	return sql$1`CAST(SUM(${t.clicks}) AS REAL) / NULLIF(SUM(${t.impressions}), 0)`;
+}
+function aggPosition(t) {
+	return sql$1`SUM(${t.sum_position}) / NULLIF(SUM(${t.impressions}), 0) + 1`;
+}
+function createSqliteInsightRunner(opts) {
+	const { executor, logger, rowsAsArrays, schema: schemaOverride } = opts;
+	const callback = async (sql, params, method) => {
+		const result = await executor(sql, params, method);
+		if (!rowsAsArrays) return { rows: result.rows };
+		return { rows: result.rows.map((r) => {
+			if (Array.isArray(r)) return r;
+			if (r && typeof r === "object") return Object.values(r);
+			return r;
+		}) };
+	};
+	return { db: drizzle(callback, {
+		schema: schemaOverride ?? schema,
+		logger
+	}) };
+}
+const { scopeFor, mergeScope } = createScopedHelpers(schema);
+export { aggClicks, aggCtr, aggImpressions, aggPosition, and, compileSqlite, createEngine, createSqliteInsightRunner, createSqliteResolverAdapter, createSqliteResolverAdapterFromExecutor, eq, gsc_countries, gsc_devices, gsc_keywords, gsc_page_keywords, gsc_pages, gte, lte, mergeScope, probeSqliteRegex, resolveWindow, schema, scopeFor, sql, sqliteResolverAdapter };

package/package.json

@@ -0,0 +1,55 @@
+{
+  "name": "@gscdump/engine-sqlite",
+  "type": "module",
+  "version": "0.4.0",
+  "description": "SQLite / D1 engine adapter for @gscdump/analysis — typed analytics over sqlite-proxy executors (Cloudflare D1, libsql).",
+  "author": {
+    "name": "Harlan Wilton",
+    "email": "harlan@harlanzw.com",
+    "url": "https://harlanzw.com/"
+  },
+  "license": "MIT",
+  "funding": "https://github.com/sponsors/harlan-zw",
+  "homepage": "https://github.com/harlan-zw/gscdump/tree/main/packages/engine-sqlite#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/harlan-zw/gscdump.git",
+    "directory": "packages/engine-sqlite"
+  },
+  "bugs": {
+    "url": "https://github.com/harlan-zw/gscdump/issues"
+  },
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.mts",
+      "import": "./dist/index.mjs"
+    }
+  },
+  "main": "./dist/index.mjs",
+  "types": "./dist/index.d.mts",
+  "files": [
+    "dist"
+  ],
+  "engines": {
+    "node": ">=18"
+  },
+  "peerDependencies": {
+    "drizzle-orm": "^0.45.2"
+  },
+  "dependencies": {
+    "@gscdump/analysis": "0.4.0",
+    "@gscdump/engine": "0.4.0",
+    "gscdump": "0.4.0"
+  },
+  "devDependencies": {
+    "drizzle-orm": "^0.45.2",
+    "vitest": "^4.1.5"
+  },
+  "scripts": {
+    "build": "obuild",
+    "dev": "obuild --stub",
+    "typecheck": "tsc --noEmit",
+    "test": "vitest"
+  }
+}