@gscdump/engine-gsc-api 0.19.7 → 0.20.1

package/dist/index.d.mts

@@ -1,6 +1,6 @@
 import { GoogleSearchConsoleClient } from "gscdump";
-import { BuilderState, Column, Dimension } from "gscdump/query";
-import { SearchType } from "@gscdump/engine";
+import { BuilderState, Column, Dimension, SearchType } from "gscdump/query";
+import { SearchType as SearchType$1 } from "@gscdump/engine";
 import { AnalysisQuerySource } from "@gscdump/engine/source";
 import { GscDataState, GscSearchAnalyticsMetadata } from "gscdump/contracts";
 declare function canProxyToGsc(state: BuilderState): boolean;
@@ -19,7 +19,7 @@ interface CreateLiveGscSourceOptions {
    * slice only. Undefined preserves pre-0.17.1 behaviour (web by default,
    * unless the BuilderState's filter already names a `searchType`).
    */
-  searchType?: SearchType;
+  searchType?: SearchType$1;
 }
 declare function createLiveGscSource(opts: CreateLiveGscSourceOptions): AnalysisQuerySource;
 interface GscRange {
@@ -46,6 +46,8 @@ interface FetchTopNOptions<D extends Dimension> {
   limit?: number;
   /** Trim after the fact (e.g. country has no server-side limit). */
   sliceTop?: number;
+  /** GSC search corpus; callers default API-boundary omissions to web. */
+  searchType?: SearchType;
 }
 declare function fetchGscTopN<D extends Dimension>(opts: FetchTopNOptions<D>): Promise<GscTopNRow[]>;
 interface GscDailyRow {
@@ -58,7 +60,8 @@ interface GscDailyRow {
 declare function fetchGscDaily(opts: {
   client: GoogleSearchConsoleClient;
   siteUrl: string;
-  range: GscRange;
+  range: GscRange; /** GSC search corpus; callers default API-boundary omissions to web. */
+  searchType?: SearchType;
 }): Promise<GscDailyRow[]>;
 interface GscApiQuerySourceOptions {
   client: GoogleSearchConsoleClient;
@@ -117,10 +120,10 @@ interface RunGscSyncSliceOptions {
    *  the continuation resumes from `nextStartRow`.
    */
   cpuBudgetMs?: number;
-  searchType?: SearchType;
+  searchType?: SearchType$1;
   /** Invoked once per successful GSC API page. Hosts wire telemetry here. */
   onPage?: (info: {
-    searchType: SearchType;
+    searchType: SearchType$1;
     rowsThisPage: number;
   }) => void;
 }

package/dist/index.mjs

@@ -39,8 +39,9 @@ async function collectRows(gen) {
 	return out;
 }
 async function fetchGscTopN(opts) {
-	const { client, siteUrl, dimension, range, orderByClicksDesc, limit, sliceTop } = opts;
+	const { client, siteUrl, dimension, range, orderByClicksDesc, limit, sliceTop, searchType } = opts;
 	let builder = gsc.select(dimension).where(between(date, range.start, range.end));
+	if (searchType) builder = builder.type(searchType);
 	if (orderByClicksDesc) builder = builder.orderBy(clicks, "desc");
 	if (typeof limit === "number") builder = builder.limit(limit);
 	const mapped = (await collectRows(client.query(siteUrl, builder))).map((r) => {
@@ -60,9 +61,11 @@ async function fetchGscTopN(opts) {
 	return typeof sliceTop === "number" ? mapped.slice(0, sliceTop) : mapped;
 }
 async function fetchGscDaily(opts) {
-	const { client, siteUrl, range } = opts;
-	const builder = gsc.select(date).where(between(date, range.start, range.end));
-	return (await collectRows(client.query(siteUrl, builder))).map((r) => {
+	const { client, siteUrl, range, searchType } = opts;
+	let builder = gsc.select(date).where(between(date, range.start, range.end));
+	if (searchType) builder = builder.type(searchType);
+	const query = builder;
+	return (await collectRows(client.query(siteUrl, query))).map((r) => {
 		const row = r;
 		if (!row.date) return null;
 		const impressions = row.impressions ?? 0;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@gscdump/engine-gsc-api",
   "type": "module",
-  "version": "0.19.7",
+  "version": "0.20.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.19.7",
-    "gscdump": "0.19.7"
+    "@gscdump/engine": "0.20.1",
+    "gscdump": "0.20.1"
   },
   "devDependencies": {
     "vitest": "^4.1.6"