@gscdump/engine-gsc-api 0.17.0 → 0.17.1

package/dist/index.d.mts

@@ -1,5 +1,6 @@
 import { GoogleSearchConsoleClient } from "gscdump";
 import { BuilderState, Column, Dimension } from "gscdump/query";
+import { SearchType } from "@gscdump/engine";
 import { AnalysisQuerySource } from "@gscdump/engine/source";
 declare function canProxyToGsc(state: BuilderState): boolean;
 interface CreateLiveGscSourceOptions {
@@ -10,6 +11,14 @@ interface CreateLiveGscSourceOptions {
    * cost is paid only when the source actually runs. Host owns refresh logic.
    */
   getAccessToken: () => Promise<string>;
+  /**
+   * GSC `searchType` slice this source is scoped to (`web`, `discover`,
+   * `news`, `googleNews`, `image`, `video`). When set, the slice is injected
+   * into every outgoing query's filter so the live API returns rows for that
+   * slice only. Undefined preserves pre-0.17.1 behaviour (web by default,
+   * unless the BuilderState's filter already names a `searchType`).
+   */
+  searchType?: SearchType;
 }
 declare function createLiveGscSource(opts: CreateLiveGscSourceOptions): AnalysisQuerySource;
 interface GscRange {

package/dist/index.mjs

@@ -113,6 +113,27 @@ function canProxyToGsc(state) {
 	if (extractSpecialOperatorFilters(state.filter).length > 0) return false;
 	return true;
 }
+function withSearchType(state, searchType) {
+	const existing = state.filter;
+	const existingFilters = existing?._filters ?? [];
+	if (existingFilters.some((f) => f.dimension === "searchType")) return state;
+	const newEntry = {
+		dimension: "searchType",
+		operator: "eq",
+		expression: searchType
+	};
+	const merged = existing ? {
+		...existing,
+		_filters: [...existingFilters, newEntry]
+	} : {
+		_filters: [newEntry],
+		_groupType: "and"
+	};
+	return {
+		...state,
+		filter: merged
+	};
+}
 function createLiveGscSource(opts) {
 	let clientPromise = null;
 	function getClient() {
@@ -129,10 +150,12 @@ function createLiveGscSource(opts) {
 			windowTotals: false
 		},
 		async queryRows(state) {
+			const client = await getClient();
+			const scopedState = opts.searchType !== void 0 ? withSearchType(state, opts.searchType) : state;
 			return createGscApiQuerySource({
-				client: await getClient(),
+				client,
 				siteUrl: opts.siteUrl
-			}).queryRows(state);
+			}).queryRows(scopedState);
 		}
 	};
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@gscdump/engine-gsc-api",
   "type": "module",
-  "version": "0.17.0",
+  "version": "0.17.1",
   "description": "GSC live-API engine adapter — wraps the Search Analytics REST API as an AnalysisQuerySource for typed analyzer dispatch.",
   "author": {
     "name": "Harlan Wilton",
@@ -36,8 +36,8 @@
     "node": ">=18"
   },
   "dependencies": {
-    "@gscdump/engine": "0.17.0",
-    "gscdump": "0.17.0"
+    "gscdump": "0.17.1",
+    "@gscdump/engine": "0.17.1"
   },
   "devDependencies": {
     "vitest": "^4.1.6"