gscdump 0.11.5 → 0.13.0

package/dist/contracts.d.mts

@@ -1,2 +1,51 @@
-import { ColumnDef, ColumnType, GscSearchAnalyticsDimension, GscSearchAnalyticsFilter, GscSearchAnalyticsFilterGroup, GscSearchAnalyticsFilterOperator, GscSearchAnalyticsRequest, GscSearchAnalyticsResponse, GscSearchAnalyticsRow, GscSearchType, Row, TableName, TableSchema, TenantCtx } from "@gscdump/contracts";
-export { type ColumnDef, type ColumnType, type GscSearchAnalyticsDimension, type GscSearchAnalyticsFilter, type GscSearchAnalyticsFilterGroup, type GscSearchAnalyticsFilterOperator, type GscSearchAnalyticsRequest, type GscSearchAnalyticsResponse, type GscSearchAnalyticsRow, type GscSearchType, type Row, type TableName, type TableSchema, type TenantCtx };
+type TableName = 'pages' | 'keywords' | 'countries' | 'devices' | 'page_keywords' | 'search_appearance';
+type Row = Record<string, unknown>;
+type ColumnType = 'DATE' | 'VARCHAR' | 'INTEGER' | 'BIGINT' | 'DOUBLE';
+interface ColumnDef {
+  name: string;
+  type: ColumnType;
+  nullable: boolean;
+}
+interface TableSchema {
+  name: TableName;
+  columns: ColumnDef[];
+  sortKey: string[];
+  version: number;
+}
+interface TenantCtx {
+  userId: string;
+  siteId?: string;
+}
+type GscSearchAnalyticsDimension = 'page' | 'query' | 'country' | 'device' | 'date' | 'searchAppearance';
+type GscSearchAnalyticsFilterOperator = 'equals' | 'notEquals' | 'contains' | 'notContains' | 'includingRegex' | 'excludingRegex';
+interface GscSearchAnalyticsFilter {
+  dimension: GscSearchAnalyticsDimension;
+  expression: string;
+  operator?: GscSearchAnalyticsFilterOperator;
+}
+interface GscSearchAnalyticsFilterGroup {
+  groupType?: 'and' | 'or';
+  filters: GscSearchAnalyticsFilter[];
+}
+type GscSearchType = 'web' | 'image' | 'video' | 'news' | 'discover' | 'googleNews';
+interface GscSearchAnalyticsRequest {
+  startDate: string;
+  endDate: string;
+  dimensions?: GscSearchAnalyticsDimension[];
+  dimensionFilterGroups?: GscSearchAnalyticsFilterGroup[];
+  rowLimit?: number;
+  startRow?: number;
+  searchType?: GscSearchType;
+}
+interface GscSearchAnalyticsRow {
+  keys: string[];
+  clicks: number;
+  impressions: number;
+  ctr: number;
+  position: number;
+}
+interface GscSearchAnalyticsResponse {
+  rows?: GscSearchAnalyticsRow[];
+  responseAggregationType?: string;
+}
+export { ColumnDef, ColumnType, GscSearchAnalyticsDimension, GscSearchAnalyticsFilter, GscSearchAnalyticsFilterGroup, GscSearchAnalyticsFilterOperator, GscSearchAnalyticsRequest, GscSearchAnalyticsResponse, GscSearchAnalyticsRow, GscSearchType, Row, TableName, TableSchema, TenantCtx };

package/dist/index.d.mts

@@ -1,6 +1,5 @@
 import { $Fetch, FetchOptions } from "ofetch";
 import { indexing_v3 } from "@googleapis/indexing/build/v3";
-import { GscSearchAnalyticsRequest } from "@gscdump/contracts";
 import { searchconsole_v1 } from "@googleapis/searchconsole/build/v1";
 /**
  * Batch runner with optional concurrency, inter-call delay, and progress.
@@ -13,6 +12,27 @@ declare function runSequentialBatch<I, R>(items: I[], operation: (item: I, index
   concurrency?: number;
   onProgress?: (result: R, index: number, total: number) => void;
 }): Promise<R[]>;
+type GscSearchAnalyticsDimension = 'page' | 'query' | 'country' | 'device' | 'date' | 'searchAppearance';
+type GscSearchAnalyticsFilterOperator = 'equals' | 'notEquals' | 'contains' | 'notContains' | 'includingRegex' | 'excludingRegex';
+interface GscSearchAnalyticsFilter {
+  dimension: GscSearchAnalyticsDimension;
+  expression: string;
+  operator?: GscSearchAnalyticsFilterOperator;
+}
+interface GscSearchAnalyticsFilterGroup {
+  groupType?: 'and' | 'or';
+  filters: GscSearchAnalyticsFilter[];
+}
+type GscSearchType = 'web' | 'image' | 'video' | 'news' | 'discover' | 'googleNews';
+interface GscSearchAnalyticsRequest {
+  startDate: string;
+  endDate: string;
+  dimensions?: GscSearchAnalyticsDimension[];
+  dimensionFilterGroups?: GscSearchAnalyticsFilterGroup[];
+  rowLimit?: number;
+  startRow?: number;
+  searchType?: GscSearchType;
+}
 declare const _default: {
   name: string;
   'alpha-2': string;
@@ -86,6 +106,7 @@ interface BuilderState {
   dimensions: Dimension[];
   metrics?: Metric[];
   filter?: Filter<any>;
+  prefilter?: Filter<any>;
   orderBy?: {
     column: Metric | 'date';
     dir: 'asc' | 'desc';
@@ -102,6 +123,7 @@ interface GSCQueryBuilder<D extends Dimension[] = [], C = object> {
     <T extends SelectableColumn[]>(...cols: T): GSCQueryBuilder<ExtractDimensions<T> & Dimension[], C>;
   };
   where: <F extends Filter<any>>(filter: F) => GSCQueryBuilder<D, C & F['_constraints']>;
+  prefilter: <F extends Filter<any>>(filter: F) => GSCQueryBuilder<D, C>;
   orderBy: (col: OrderableColumn, dir: 'asc' | 'desc') => GSCQueryBuilder<D, C>;
   limit: (n: number) => GSCQueryBuilder<D, C>;
   offset: (n: number) => GSCQueryBuilder<D, C>;

package/dist/query/index.d.mts

@@ -1,5 +1,26 @@
 import _dayjs, { Dayjs } from "dayjs";
-import { GscSearchAnalyticsRequest, TableName } from "@gscdump/contracts";
+type TableName = 'pages' | 'keywords' | 'countries' | 'devices' | 'page_keywords' | 'search_appearance';
+type GscSearchAnalyticsDimension = 'page' | 'query' | 'country' | 'device' | 'date' | 'searchAppearance';
+type GscSearchAnalyticsFilterOperator = 'equals' | 'notEquals' | 'contains' | 'notContains' | 'includingRegex' | 'excludingRegex';
+interface GscSearchAnalyticsFilter {
+  dimension: GscSearchAnalyticsDimension;
+  expression: string;
+  operator?: GscSearchAnalyticsFilterOperator;
+}
+interface GscSearchAnalyticsFilterGroup {
+  groupType?: 'and' | 'or';
+  filters: GscSearchAnalyticsFilter[];
+}
+type GscSearchType = 'web' | 'image' | 'video' | 'news' | 'discover' | 'googleNews';
+interface GscSearchAnalyticsRequest {
+  startDate: string;
+  endDate: string;
+  dimensions?: GscSearchAnalyticsDimension[];
+  dimensionFilterGroups?: GscSearchAnalyticsFilterGroup[];
+  rowLimit?: number;
+  startRow?: number;
+  searchType?: GscSearchType;
+}
 declare const _default: {
   name: string;
   'alpha-2': string;
@@ -82,6 +103,7 @@ interface BuilderState {
   dimensions: Dimension[];
   metrics?: Metric[];
   filter?: Filter<any>;
+  prefilter?: Filter<any>;
   orderBy?: {
     column: Metric | 'date';
     dir: 'asc' | 'desc';
@@ -110,6 +132,7 @@ interface GSCQueryBuilder<D extends Dimension[] = [], C = object> {
     <T extends SelectableColumn[]>(...cols: T): GSCQueryBuilder<ExtractDimensions<T> & Dimension[], C>;
   };
   where: <F extends Filter<any>>(filter: F) => GSCQueryBuilder<D, C & F['_constraints']>;
+  prefilter: <F extends Filter<any>>(filter: F) => GSCQueryBuilder<D, C>;
   orderBy: (col: OrderableColumn, dir: 'asc' | 'desc') => GSCQueryBuilder<D, C>;
   limit: (n: number) => GSCQueryBuilder<D, C>;
   offset: (n: number) => GSCQueryBuilder<D, C>;
@@ -194,6 +217,7 @@ interface LogicalQueryPlan {
   dimensionFilters: LogicalDimensionFilter[];
   dimensionFilterTree?: LogicalFilterNode;
   metricFilters: LogicalMetricFilter[];
+  prefilters: LogicalMetricFilter[];
   specialFilters: {
     topLevel: boolean;
   };

package/dist/query/index.mjs

@@ -258,6 +258,12 @@ function createBuilder(state) {
 				filter
 			});
 		},
+		prefilter(filter) {
+			return createBuilder({
+				...state,
+				prefilter: filter
+			});
+		},
 		orderBy(col, dir) {
 			const column = isMetricColumn(col) ? col.metric : col.dimension;
 			return createBuilder({
@@ -1995,6 +2001,7 @@ function buildLogicalPlan(state, capabilities = {}) {
 	const allFilters = collectInternalFilters(normalizedFilter);
 	const metricFilters = extractMetricFilters(normalizedFilter);
 	const specialFilters = extractSpecialOperatorFilters(normalizedFilter);
+	const prefilters = extractMetricFilters(normalizeFilter(state.prefilter));
 	const queryParams = {};
 	const dimensionFilters = [];
 	for (const filter of allFilters) {
@@ -2039,6 +2046,12 @@ function buildLogicalPlan(state, capabilities = {}) {
 			expression: Number(filter.expression),
 			expression2: filter.expression2 == null ? void 0 : Number(filter.expression2)
 		})),
+		prefilters: prefilters.map((filter) => ({
+			metric: filter.dimension,
+			operator: filter.operator,
+			expression: Number(filter.expression),
+			expression2: filter.expression2 == null ? void 0 : Number(filter.expression2)
+		})),
 		specialFilters: { topLevel: specialFilters.some((filter) => filter.operator === "topLevel") },
 		queryParams,
 		orderBy: state.orderBy,

package/dist/query/plan.d.mts

@@ -1,4 +1,4 @@
-import { TableName } from "@gscdump/contracts";
+type TableName = 'pages' | 'keywords' | 'countries' | 'devices' | 'page_keywords' | 'search_appearance';
 declare const _default: {
   name: string;
   'alpha-2': string;
@@ -58,6 +58,7 @@ interface BuilderState {
   dimensions: Dimension[];
   metrics?: Metric[];
   filter?: Filter<any>;
+  prefilter?: Filter<any>;
   orderBy?: {
     column: Metric | 'date';
     dir: 'asc' | 'desc';
@@ -108,6 +109,7 @@ interface LogicalQueryPlan {
   dimensionFilters: LogicalDimensionFilter[];
   dimensionFilterTree?: LogicalFilterNode;
   metricFilters: LogicalMetricFilter[];
+  prefilters: LogicalMetricFilter[];
   specialFilters: {
     topLevel: boolean;
   };

package/dist/query/plan.mjs

@@ -231,6 +231,7 @@ function buildLogicalPlan(state, capabilities = {}) {
 	const allFilters = collectInternalFilters(normalizedFilter);
 	const metricFilters = extractMetricFilters(normalizedFilter);
 	const specialFilters = extractSpecialOperatorFilters(normalizedFilter);
+	const prefilters = extractMetricFilters(normalizeFilter(state.prefilter));
 	const queryParams = {};
 	const dimensionFilters = [];
 	for (const filter of allFilters) {
@@ -275,6 +276,12 @@ function buildLogicalPlan(state, capabilities = {}) {
 			expression: Number(filter.expression),
 			expression2: filter.expression2 == null ? void 0 : Number(filter.expression2)
 		})),
+		prefilters: prefilters.map((filter) => ({
+			metric: filter.dimension,
+			operator: filter.operator,
+			expression: Number(filter.expression),
+			expression2: filter.expression2 == null ? void 0 : Number(filter.expression2)
+		})),
 		specialFilters: { topLevel: specialFilters.some((filter) => filter.operator === "topLevel") },
 		queryParams,
 		orderBy: state.orderBy,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "gscdump",
   "type": "module",
-  "version": "0.11.5",
+  "version": "0.13.0",
   "description": "Google Search Console API wrapper with typed query builder, streaming pagination, and SEO analysis functions",
   "author": {
     "name": "Harlan Wilton",
@@ -108,7 +108,7 @@
     "defu": "^6.1.7",
     "ofetch": "^1.5.1",
     "ufo": "^1.6.4",
-    "@gscdump/contracts": "0.11.5"
+    "@gscdump/contracts": "0.13.0"
   },
   "devDependencies": {
     "@googleapis/indexing": "^6.0.1",