@gscdump/engine-gsc-api 5.3.0 → 5.6.0

package/dist/index.d.mts

@@ -2,5 +2,5 @@ import { CreateLiveGscSourceOptions, canProxyToGsc, createLiveGscSource } from "
 import { FetchTopNOptions, GscDailyRow, GscRange, GscTopNRow, fetchGscDaily, fetchGscTopN } from "./rollup-synth.mjs";
 import { GSC_API_CAPABILITIES, GscApiQuerySourceOptions, createGscApiQuerySource } from "./source.mjs";
 import { GscSyncEntryWork, GscSyncFanoutEntry, GscSyncLedgerRow, GscSyncWindow, GscSyncWorkPlan, PlanGscBackfillDatesOptions, PlanGscBackwardDatesOptions, PlanGscSyncWorkOptions, gscSyncFanout, ledgerTablesForGscSync, planGscBackfillDates, planGscSyncWork, tablesCoveredByGscSync } from "./sync-plan.mjs";
-import { GscAggregation, GscApiRow, RunGscSearchAppearanceContextSliceOptions, RunGscSearchAppearanceContextSliceResult, RunGscSyncSliceOptions, RunGscSyncSliceResult, SearchAppearanceContextGrain, SearchAppearanceContextTable, SyncSliceDimensionFilter, SyncSliceDomainFilter, hostPagePattern, requestAggregation, runGscSearchAppearanceContextSlice, runGscSyncSlice } from "./sync-slice.mjs";
-export { type CreateLiveGscSourceOptions, type FetchTopNOptions, GSC_API_CAPABILITIES, type GscAggregation, type GscApiQuerySourceOptions, type GscApiRow, type GscDailyRow, type GscRange, type GscSyncEntryWork, type GscSyncFanoutEntry, type GscSyncLedgerRow, type GscSyncWindow, type GscSyncWorkPlan, type GscTopNRow, type PlanGscBackfillDatesOptions, type PlanGscBackwardDatesOptions, type PlanGscSyncWorkOptions, type RunGscSearchAppearanceContextSliceOptions, type RunGscSearchAppearanceContextSliceResult, type RunGscSyncSliceOptions, type RunGscSyncSliceResult, type SearchAppearanceContextGrain, type SearchAppearanceContextTable, type SyncSliceDimensionFilter, type SyncSliceDomainFilter, canProxyToGsc, createGscApiQuerySource, createLiveGscSource, fetchGscDaily, fetchGscTopN, gscSyncFanout, hostPagePattern, ledgerTablesForGscSync, planGscBackfillDates, planGscSyncWork, requestAggregation, runGscSearchAppearanceContextSlice, runGscSyncSlice, tablesCoveredByGscSync };
+import { GscAggregation, GscApiRow, GscCommittedPage, RunGscSearchAppearanceContextSliceOptions, RunGscSearchAppearanceContextSliceResult, RunGscSyncSliceOptions, RunGscSyncSliceResult, SearchAppearanceContextGrain, SearchAppearanceContextTable, SyncSliceDimensionFilter, SyncSliceDomainFilter, hostPagePattern, requestAggregation, runGscSearchAppearanceContextSlice, runGscSyncSlice } from "./sync-slice.mjs";
+export { type CreateLiveGscSourceOptions, type FetchTopNOptions, GSC_API_CAPABILITIES, type GscAggregation, type GscApiQuerySourceOptions, type GscApiRow, type GscCommittedPage, type GscDailyRow, type GscRange, type GscSyncEntryWork, type GscSyncFanoutEntry, type GscSyncLedgerRow, type GscSyncWindow, type GscSyncWorkPlan, type GscTopNRow, type PlanGscBackfillDatesOptions, type PlanGscBackwardDatesOptions, type PlanGscSyncWorkOptions, type RunGscSearchAppearanceContextSliceOptions, type RunGscSearchAppearanceContextSliceResult, type RunGscSyncSliceOptions, type RunGscSyncSliceResult, type SearchAppearanceContextGrain, type SearchAppearanceContextTable, type SyncSliceDimensionFilter, type SyncSliceDomainFilter, canProxyToGsc, createGscApiQuerySource, createLiveGscSource, fetchGscDaily, fetchGscTopN, gscSyncFanout, hostPagePattern, ledgerTablesForGscSync, planGscBackfillDates, planGscSyncWork, requestAggregation, runGscSearchAppearanceContextSlice, runGscSyncSlice, tablesCoveredByGscSync };

package/dist/sync-slice.d.mts

@@ -1,4 +1,4 @@
-import { GoogleSearchConsoleClient } from "gscdump";
+import { GoogleSearchConsoleClient, SearchAnalyticsQuery } from "gscdump";
 import { SearchType } from "@gscdump/engine";
 import { GscDataState, GscSearchAnalyticsMetadata } from "gscdump/contracts";
 export interface GscApiRow {
@@ -8,6 +8,14 @@ export interface GscApiRow {
   ctr: number;
   position: number;
 }
+export interface GscCommittedPage {
+  siteUrl: string;
+  request: SearchAnalyticsQuery;
+  rows: GscApiRow[];
+  terminal: boolean;
+  aggregation: GscAggregation;
+  metadata: GscSearchAnalyticsMetadata | undefined;
+}
 export interface SyncSliceDomainFilter {
   /**
    * Exact registered host to scope the slice to, without a protocol.
@@ -67,6 +75,8 @@ export interface RunGscSyncSliceOptions {
     searchType: SearchType;
     rowsThisPage: number;
   }) => void;
+  /** Durable outcomes include empty terminal pages and follow successful batch commits. */
+  onCommittedPage?: (page: GscCommittedPage) => Promise<void>;
 }
 /**
  * How GSC counted impressions for a request. Grouping or filtering by `page`
@@ -116,6 +126,7 @@ export interface RunGscSearchAppearanceContextSliceOptions {
     searchType: SearchType;
     rowsThisPage: number;
   }) => void;
+  onCommittedPage?: (page: GscCommittedPage) => Promise<void>;
   continuation?: SearchAppearanceContinuation;
 }
 export type SearchAppearanceContinuation = {

package/dist/sync-slice.mjs

@@ -75,6 +75,7 @@ async function runGscSyncSlice(opts) {
 			return {
 				kind: "ok",
 				startRow: row,
+				request: query,
 				reported: reportedAggregation(response.responseAggregationType),
 				rows: response.rows ?? [],
 				metadata: response.metadata
@@ -138,6 +139,14 @@ async function runGscSyncSlice(opts) {
 				aggregation
 			};
 		}
+		await opts.onCommittedPage?.({
+			siteUrl: opts.siteUrl,
+			request: page.request,
+			rows,
+			terminal: isLastPage,
+			aggregation,
+			metadata: page.metadata
+		});
 		if (isLastPage) return {
 			totalRows,
 			hasMore: false,
@@ -193,6 +202,7 @@ async function runGscSearchAppearanceContextSlice(opts) {
 			searchType: opts.searchType,
 			initialStartRow: opts.continuation?.phase === "discovery" ? opts.continuation.nextStartRow : void 0,
 			onPage: opts.onPage,
+			onCommittedPage: opts.onCommittedPage,
 			onBatch: async (rows) => {
 				for (const row of rows) {
 					const value = String(row.keys?.[0] ?? "");
@@ -241,6 +251,7 @@ async function runGscSearchAppearanceContextSlice(opts) {
 			searchType: opts.searchType,
 			initialStartRow: i === startIndex ? startRow : void 0,
 			onPage: opts.onPage,
+			onCommittedPage: opts.onCommittedPage,
 			onBatch: (rows) => opts.onContextBatch({
 				searchAppearance,
 				table,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@gscdump/engine-gsc-api",
   "type": "module",
-  "version": "5.3.0",
+  "version": "5.6.0",
   "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": ">=22.13.0"
   },
   "dependencies": {
-    "@gscdump/engine": "^5.3.0",
-    "gscdump": "^5.3.0"
+    "@gscdump/engine": "^5.6.0",
+    "gscdump": "^5.6.0"
   },
   "devDependencies": {
     "vitest": "^5.0.1"