gscdump 0.11.2 → 0.11.3

package/dist/contracts.d.mts

@@ -32,4 +32,49 @@ interface TenantCtx {
   userId: string;
   siteId?: string;
 }
-export { ColumnDef, ColumnType, Row, TableName, TableSchema, TenantCtx };
+/**
+ * Dimensions accepted by the Google Search Console Search Analytics API.
+ *
+ * This intentionally excludes package-only logical dimensions such as
+ * `queryCanonical`; host apps must route those through an engine-backed path.
+ */
+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';
+/**
+ * Canonical host-facing Search Analytics request body.
+ *
+ * Google's generated client type also has deprecated/alternate fields. The
+ * gscdump query builder emits `searchType`, so apps should forward that field
+ * unchanged rather than translating it to `type`.
+ */
+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

@@ -12,71 +12,39 @@ declare function runSequentialBatch<I, R>(items: I[], operation: (item: I, index
   concurrency?: number;
   onProgress?: (result: R, index: number, total: number) => void;
 }): Promise<R[]>;
-type ApiSite = searchconsole_v1.Schema$WmxSite;
-type ApiSitemap = searchconsole_v1.Schema$WmxSitemap;
-type ApiSitemapContent = searchconsole_v1.Schema$WmxSitemapContent;
-type SearchAnalyticsQuery = searchconsole_v1.Schema$SearchAnalyticsQueryRequest;
-type SearchAnalyticsResponse = searchconsole_v1.Schema$SearchAnalyticsQueryResponse;
-type DataRow = searchconsole_v1.Schema$ApiDataRow;
-type DimensionFilter = searchconsole_v1.Schema$ApiDimensionFilter;
-type DimensionFilterGroup = searchconsole_v1.Schema$ApiDimensionFilterGroup;
-type UrlInspectionResult = searchconsole_v1.Schema$UrlInspectionResult;
-type IndexStatusResult = searchconsole_v1.Schema$IndexStatusInspectionResult;
-type MobileUsabilityResult = searchconsole_v1.Schema$MobileUsabilityInspectionResult;
-type RichResultsResult = searchconsole_v1.Schema$RichResultsInspectionResult;
-type InspectUrlIndexResponse = searchconsole_v1.Schema$InspectUrlIndexResponse;
-type UrlNotificationMetadata = indexing_v3.Schema$UrlNotificationMetadata;
-type PublishUrlNotificationResponse = indexing_v3.Schema$PublishUrlNotificationResponse;
-type RequiredNonNullable<T> = Required<Exclude<T, null | undefined>>;
-interface Site extends Required<Omit<ApiSite, 'siteUrl'>> {
-  siteUrl: string;
+/**
+ * Dimensions accepted by the Google Search Console Search Analytics API.
+ *
+ * This intentionally excludes package-only logical dimensions such as
+ * `queryCanonical`; host apps must route those through an engine-backed path.
+ */
+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 Period {
-  start: Date | string;
-  end: Date | string;
+interface GscSearchAnalyticsFilterGroup {
+  groupType?: 'and' | 'or';
+  filters: GscSearchAnalyticsFilter[];
 }
-interface ResolvedAnalyticsRange {
-  period: Period;
-  prevPeriod?: Period;
-}
-interface SiteAnalytics {
-  analytics: {
-    period: {
-      totalClicks: number;
-      totalImpressions: number;
-    };
-    prevPeriod: {
-      totalClicks: number;
-      totalImpressions: number;
-    };
-  };
-  sitemaps: ApiSitemap[];
-  indexedUrls: string[];
-  period: {
-    url: string;
-    clicks: number;
-    clicksPercent: number;
-    prevClicks: number;
-    impressions: number;
-    impressionsPercent: number;
-    prevImpressions: number;
-  }[];
-  keywords: {
-    keyword: string;
-    position: number;
-    prevPosition: number;
-    positionPercent: number;
-    ctr: number;
-    ctrPercent: number;
-    prevCtr: number;
-    clicks: number;
-  }[];
-  graph: {
-    keys?: undefined;
-    time: string;
-    clicks: number;
-    impressions: number;
-  }[];
+type GscSearchType = 'web' | 'image' | 'video' | 'news' | 'discover' | 'googleNews';
+/**
+ * Canonical host-facing Search Analytics request body.
+ *
+ * Google's generated client type also has deprecated/alternate fields. The
+ * gscdump query builder emits `searchType`, so apps should forward that field
+ * unchanged rather than translating it to `type`.
+ */
+interface GscSearchAnalyticsRequest {
+  startDate: string;
+  endDate: string;
+  dimensions?: GscSearchAnalyticsDimension[];
+  dimensionFilterGroups?: GscSearchAnalyticsFilterGroup[];
+  rowLimit?: number;
+  startRow?: number;
+  searchType?: GscSearchType;
 }
 declare const _default: {
   name: string;
@@ -170,9 +138,75 @@ interface GSCQueryBuilder<D extends Dimension[] = [], C = object> {
   orderBy: (col: OrderableColumn, dir: 'asc' | 'desc') => GSCQueryBuilder<D, C>;
   limit: (n: number) => GSCQueryBuilder<D, C>;
   offset: (n: number) => GSCQueryBuilder<D, C>;
-  toBody: () => SearchAnalyticsQuery;
+  toBody: () => GscSearchAnalyticsRequest;
   getState: () => BuilderState;
 }
+type ApiSite = searchconsole_v1.Schema$WmxSite;
+type ApiSitemap = searchconsole_v1.Schema$WmxSitemap;
+type ApiSitemapContent = searchconsole_v1.Schema$WmxSitemapContent;
+type SearchAnalyticsQuery = searchconsole_v1.Schema$SearchAnalyticsQueryRequest;
+type SearchAnalyticsResponse = searchconsole_v1.Schema$SearchAnalyticsQueryResponse;
+type DataRow = searchconsole_v1.Schema$ApiDataRow;
+type DimensionFilter = searchconsole_v1.Schema$ApiDimensionFilter;
+type DimensionFilterGroup = searchconsole_v1.Schema$ApiDimensionFilterGroup;
+type UrlInspectionResult = searchconsole_v1.Schema$UrlInspectionResult;
+type IndexStatusResult = searchconsole_v1.Schema$IndexStatusInspectionResult;
+type MobileUsabilityResult = searchconsole_v1.Schema$MobileUsabilityInspectionResult;
+type RichResultsResult = searchconsole_v1.Schema$RichResultsInspectionResult;
+type InspectUrlIndexResponse = searchconsole_v1.Schema$InspectUrlIndexResponse;
+type UrlNotificationMetadata = indexing_v3.Schema$UrlNotificationMetadata;
+type PublishUrlNotificationResponse = indexing_v3.Schema$PublishUrlNotificationResponse;
+type RequiredNonNullable<T> = Required<Exclude<T, null | undefined>>;
+interface Site extends Required<Omit<ApiSite, 'siteUrl'>> {
+  siteUrl: string;
+}
+interface Period {
+  start: Date | string;
+  end: Date | string;
+}
+interface ResolvedAnalyticsRange {
+  period: Period;
+  prevPeriod?: Period;
+}
+interface SiteAnalytics {
+  analytics: {
+    period: {
+      totalClicks: number;
+      totalImpressions: number;
+    };
+    prevPeriod: {
+      totalClicks: number;
+      totalImpressions: number;
+    };
+  };
+  sitemaps: ApiSitemap[];
+  indexedUrls: string[];
+  period: {
+    url: string;
+    clicks: number;
+    clicksPercent: number;
+    prevClicks: number;
+    impressions: number;
+    impressionsPercent: number;
+    prevImpressions: number;
+  }[];
+  keywords: {
+    keyword: string;
+    position: number;
+    prevPosition: number;
+    positionPercent: number;
+    ctr: number;
+    ctrPercent: number;
+    prevCtr: number;
+    clicks: number;
+  }[];
+  graph: {
+    keys?: undefined;
+    time: string;
+    clicks: number;
+    impressions: number;
+  }[];
+}
 type VerificationMethod = 'META' | 'FILE' | 'DNS_TXT' | 'DNS_CNAME' | 'ANALYTICS' | 'TAG_MANAGER';
 type VerificationSiteType = 'SITE' | 'INET_DOMAIN' | 'ANDROID_APP';
 interface VerificationSite {

package/dist/query/index.d.mts

@@ -1,6 +1,48 @@
 import _dayjs, { Dayjs } from "dayjs";
-import { searchconsole_v1 } from "@googleapis/searchconsole/build/v1";
-type SearchAnalyticsQuery = searchconsole_v1.Schema$SearchAnalyticsQueryRequest;
+/**
+ * Canonical cross-package contracts. Type-only — zero runtime cost.
+ *
+ * Imported by @gscdump/engine, @gscdump/analysis, @gscdump/cli, @gscdump/mcp,
+ * @gscdump/cloud as the single source of truth for cross-cutting types so
+ * schema identifiers, tenant shape, and analyzer IO can't drift across
+ * packages.
+ */
+/** Logical table / dataset identifier. Canonical across query builder + storage engine. */
+type TableName = 'pages' | 'keywords' | 'countries' | 'devices' | 'page_keywords' | 'search_appearance';
+/**
+ * Dimensions accepted by the Google Search Console Search Analytics API.
+ *
+ * This intentionally excludes package-only logical dimensions such as
+ * `queryCanonical`; host apps must route those through an engine-backed path.
+ */
+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';
+/**
+ * Canonical host-facing Search Analytics request body.
+ *
+ * Google's generated client type also has deprecated/alternate fields. The
+ * gscdump query builder emits `searchType`, so apps should forward that field
+ * unchanged rather than translating it to `type`.
+ */
+interface GscSearchAnalyticsRequest {
+  startDate: string;
+  endDate: string;
+  dimensions?: GscSearchAnalyticsDimension[];
+  dimensionFilterGroups?: GscSearchAnalyticsFilterGroup[];
+  rowLimit?: number;
+  startRow?: number;
+  searchType?: GscSearchType;
+}
 declare const _default: {
   name: string;
   'alpha-2': string;
@@ -114,7 +156,7 @@ interface GSCQueryBuilder<D extends Dimension[] = [], C = object> {
   orderBy: (col: OrderableColumn, dir: 'asc' | 'desc') => GSCQueryBuilder<D, C>;
   limit: (n: number) => GSCQueryBuilder<D, C>;
   offset: (n: number) => GSCQueryBuilder<D, C>;
-  toBody: () => SearchAnalyticsQuery;
+  toBody: () => GscSearchAnalyticsRequest;
   getState: () => BuilderState;
 }
 declare const gsc: GSCQueryBuilder<[], object>;
@@ -152,16 +194,6 @@ declare function lt<D extends Dimension>(column: Column<D>, value: DimensionValu
 declare function between<M extends Metric>(column: MetricColumn<M>, start: number, end: number): Filter<object>;
 declare function between<D extends Dimension>(column: Column<D>, start: DimensionValueMap[D], end: DimensionValueMap[D]): Filter<object>;
 declare function topLevel(column: Column<'page'>): Filter<object>;
-/**
- * Canonical cross-package contracts. Type-only — zero runtime cost.
- *
- * Imported by @gscdump/engine, @gscdump/analysis, @gscdump/cli, @gscdump/mcp,
- * @gscdump/cloud as the single source of truth for cross-cutting types so
- * schema identifiers, tenant shape, and analyzer IO can't drift across
- * packages.
- */
-/** Logical table / dataset identifier. Canonical across query builder + storage engine. */
-type TableName = 'pages' | 'keywords' | 'countries' | 'devices' | 'page_keywords' | 'search_appearance';
 type LogicalDataset = TableName;
 type ComparisonFilter = 'new' | 'lost' | 'improving' | 'declining';
 interface PlannerCapabilities {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "gscdump",
   "type": "module",
-  "version": "0.11.2",
+  "version": "0.11.3",
   "description": "Google Search Console API wrapper with typed query builder, streaming pagination, and SEO analysis functions",
   "author": {
     "name": "Harlan Wilton",