@gscdump/contracts 0.26.10 → 0.27.0

package/dist/_chunks/webhook-constants.d.mts

@@ -0,0 +1,9 @@
+declare const WEBHOOK_CONTRACT_VERSION = "2026-05-11";
+declare const WEBHOOK_SIGNATURE_HEADER = "X-GSCDump-Signature";
+declare const WEBHOOK_EVENT_HEADER = "X-GSCDump-Event";
+declare const WEBHOOK_DELIVERY_HEADER = "X-GSCDump-Delivery";
+declare const WEBHOOK_CONTRACT_VERSION_HEADER = "X-GSCDump-Contract-Version";
+declare const WEBHOOK_TIMESTAMP_HEADER = "X-GSCDump-Timestamp";
+declare const CANONICAL_WEBHOOK_EVENTS: readonly ["user.lifecycle.changed", "site.lifecycle.changed", "site.analytics.ready", "site.indexing.ready", "site.auth.failed", "job.failed"];
+declare const VALID_WEBHOOK_EVENTS: readonly ["user.lifecycle.changed", "site.lifecycle.changed", "site.analytics.ready", "site.indexing.ready", "site.auth.failed", "job.failed"];
+export { CANONICAL_WEBHOOK_EVENTS, VALID_WEBHOOK_EVENTS, WEBHOOK_CONTRACT_VERSION, WEBHOOK_CONTRACT_VERSION_HEADER, WEBHOOK_DELIVERY_HEADER, WEBHOOK_EVENT_HEADER, WEBHOOK_SIGNATURE_HEADER, WEBHOOK_TIMESTAMP_HEADER };

package/dist/analytics.d.mts

@@ -0,0 +1,3 @@
+import { analyticsEndpointSchemas, analyticsRoutes } from "./_chunks/schemas.mjs";
+import { AddPartnerTeamMemberParams, AnalysisSourcesOptions, AnalysisSourcesResponse, AnalyticsClient, BackfillRange, BackfillResponse, BindPartnerSiteTeamParams, BuilderState, BulkRegisterPartnerSiteResult, BulkRegisterPartnerSitesParams, BulkRegisterPartnerSitesResponse, CanonicalWebhookEventType, ColumnDef, ColumnType, CountriesResponse, CountryRow, CreatePartnerTeamParams, CreateWebhookEnvelopeOptions, DataDetailOptions, DataQueryOptions, DeletePartnerUserResponse, Dimension, Filter, Grain, GscApiRange, GscComparisonFilter, GscRowQueryMeta, GscRowQueryResponse, GscSearchType, GscdumpAnalysisParams, GscdumpAnalysisPreset, GscdumpAnalysisResponse, GscdumpAnalysisSourcesResponse, GscdumpAvailableSite, GscdumpCanonicalMismatchRow, GscdumpCanonicalMismatchesResponse, GscdumpDataDetailResponse, GscdumpDataResponse, GscdumpDataRow, GscdumpDateRangeParams, GscdumpHealthResponse, GscdumpIndexPercentResponse, GscdumpIndexPercentSitemap, GscdumpIndexPercentTrendPoint, GscdumpIndexingDiagnosticsResponse, GscdumpIndexingInspectRateLimited, GscdumpIndexingInspectRequest, GscdumpIndexingInspectResponse, GscdumpIndexingInspectResult, GscdumpIndexingIssueSeverity, GscdumpIndexingResponse, GscdumpIndexingTrendPoint, GscdumpIndexingUrl, GscdumpIndexingUrlStatus, GscdumpIndexingUrlsResponse, GscdumpInvisibleUrlRow, GscdumpKeywordSparklinesParams, GscdumpKeywordSparklinesResponse, GscdumpMeta, GscdumpOrphanPageRow, GscdumpPageTrendParams, GscdumpPageTrendResponse, GscdumpPerSitemapHistoryEntry, GscdumpPermissionRecovery, GscdumpQueryTrendParams, GscdumpQueryTrendResponse, GscdumpRichResultItem, GscdumpSiteRegistration, GscdumpSiteReportResponse, GscdumpSitemap, GscdumpSitemapChangesResponse, GscdumpSitemapHistory, GscdumpSitemapsResponse, GscdumpSyncJobItem, GscdumpSyncJobStatus, GscdumpSyncJobsQueueCounts, GscdumpSyncJobsResponse, GscdumpSyncProgressDateStatus, GscdumpSyncProgressPhaseCounts, GscdumpSyncProgressResponse, GscdumpSyncProgressSite, GscdumpSyncStatusResponse, GscdumpTeamMemberRow, GscdumpTeamRow, GscdumpTopAssociationParams, GscdumpTopAssociationResponse, GscdumpTotals, GscdumpUserMeResponse, GscdumpUserRegistration, GscdumpUserSettings, GscdumpUserSite, GscdumpUserStatus, GscdumpUserTokenUpdate, IndexingDiagnostics, IndexingInspectRateLimit, IndexingInspectRateLimited, IndexingInspectRequest, IndexingInspectResponse, IndexingInspectResult, IndexingIssue, IndexingIssueSeverity, IndexingUrlRow, IndexingUrlStatus, IndexingUrlsParams, IndexingUrlsResponse, InspectionHistoryRecord, InspectionHistoryResponse, InspectionIndex, InspectionRecordRaw, Metric, PartnerClient, PartnerLifecycleAccount, PartnerLifecycleResponse, PartnerLifecycleSite, PartnerRealtimeEvent, PartnerRealtimeEventType, PartnerRealtimeMessage, PartnerWebhookData, PartnerWebhookHeaders, RealtimeAuthFailedEvent, RealtimeAuthRequiredMessage, RealtimeConnectedMessage, RealtimeEnrichmentCompleteEvent, RealtimeErrorMessage, RealtimeJobFailedEvent, RealtimeNeedsReauthEvent, RealtimePongMessage, RealtimeSiteAddedEvent, RealtimeSiteRemovedEvent, RealtimeSubscribedMessage, RealtimeSyncCompleteEvent, RealtimeSyncFailedEvent, RealtimeSyncJobCompleteEvent, RealtimeSyncProgressEvent, RealtimeSyncSiteCompleteEvent, RegisterPartnerSiteParams, RegisterPartnerUserParams, RollupEnvelope, Row, ScheduleState, SearchAppearanceResponse, SearchAppearanceRow, SearchTypeOptions, SiteListItem, SitemapAddedRow, SitemapChangesResponse, SitemapHistoryRecord, SitemapHistoryResponse, SitemapIndex, SitemapRemovedRow, SourceInfoOptions, SourceInfoResponse, TableName, TableSchema, TenantCtx, UpdatePartnerUserTokensParams, WebhookEnvelope, WebhookEventType, WhoamiResponse } from "./_chunks/types.mjs";
+export { type AddPartnerTeamMemberParams, type AnalysisSourcesOptions, type AnalysisSourcesResponse, type AnalyticsClient, type BackfillRange, type BackfillResponse, type BindPartnerSiteTeamParams, type BuilderState, type BulkRegisterPartnerSiteResult, type BulkRegisterPartnerSitesParams, type BulkRegisterPartnerSitesResponse, type CanonicalWebhookEventType, type ColumnDef, type ColumnType, type CountriesResponse, type CountryRow, type CreatePartnerTeamParams, type CreateWebhookEnvelopeOptions, type DataDetailOptions, type DataQueryOptions, type DeletePartnerUserResponse, type Dimension, type Filter, type Grain, type GscApiRange, type GscComparisonFilter, type GscRowQueryMeta, type GscRowQueryResponse, type GscSearchType, type GscdumpAnalysisParams, type GscdumpAnalysisPreset, type GscdumpAnalysisResponse, type GscdumpAnalysisSourcesResponse, type GscdumpAvailableSite, type GscdumpCanonicalMismatchRow, type GscdumpCanonicalMismatchesResponse, type GscdumpDataDetailResponse, type GscdumpDataResponse, type GscdumpDataRow, type GscdumpDateRangeParams, type GscdumpHealthResponse, type GscdumpIndexPercentResponse, type GscdumpIndexPercentSitemap, type GscdumpIndexPercentTrendPoint, type GscdumpIndexingDiagnosticsResponse, type GscdumpIndexingInspectRateLimited, type GscdumpIndexingInspectRequest, type GscdumpIndexingInspectResponse, type GscdumpIndexingInspectResult, type GscdumpIndexingIssueSeverity, type GscdumpIndexingResponse, type GscdumpIndexingTrendPoint, type GscdumpIndexingUrl, type GscdumpIndexingUrlStatus, type GscdumpIndexingUrlsResponse, type GscdumpInvisibleUrlRow, type GscdumpKeywordSparklinesParams, type GscdumpKeywordSparklinesResponse, type GscdumpMeta, type GscdumpOrphanPageRow, type GscdumpPageTrendParams, type GscdumpPageTrendResponse, type GscdumpPerSitemapHistoryEntry, type GscdumpPermissionRecovery, type GscdumpQueryTrendParams, type GscdumpQueryTrendResponse, type GscdumpRichResultItem, type GscdumpSiteRegistration, type GscdumpSiteReportResponse, type GscdumpSitemap, type GscdumpSitemapChangesResponse, type GscdumpSitemapHistory, type GscdumpSitemapsResponse, type GscdumpSyncJobItem, type GscdumpSyncJobStatus, type GscdumpSyncJobsQueueCounts, type GscdumpSyncJobsResponse, type GscdumpSyncProgressDateStatus, type GscdumpSyncProgressPhaseCounts, type GscdumpSyncProgressResponse, type GscdumpSyncProgressSite, type GscdumpSyncStatusResponse, type GscdumpTeamMemberRow, type GscdumpTeamRow, type GscdumpTopAssociationParams, type GscdumpTopAssociationResponse, type GscdumpTotals, type GscdumpUserMeResponse, type GscdumpUserRegistration, type GscdumpUserSettings, type GscdumpUserSite, type GscdumpUserStatus, type GscdumpUserTokenUpdate, type IndexingDiagnostics, type IndexingInspectRateLimit, type IndexingInspectRateLimited, type IndexingInspectRequest, type IndexingInspectResponse, type IndexingInspectResult, type IndexingIssue, type IndexingIssueSeverity, type IndexingUrlRow, type IndexingUrlStatus, type IndexingUrlsParams, type IndexingUrlsResponse, type InspectionHistoryRecord, type InspectionHistoryResponse, type InspectionIndex, type InspectionRecordRaw, type Metric, type PartnerClient, type PartnerLifecycleAccount, type PartnerLifecycleResponse, type PartnerLifecycleSite, type PartnerRealtimeEvent, type PartnerRealtimeEventType, type PartnerRealtimeMessage, type PartnerWebhookData, type PartnerWebhookHeaders, type RealtimeAuthFailedEvent, type RealtimeAuthRequiredMessage, type RealtimeConnectedMessage, type RealtimeEnrichmentCompleteEvent, type RealtimeErrorMessage, type RealtimeJobFailedEvent, type RealtimeNeedsReauthEvent, type RealtimePongMessage, type RealtimeSiteAddedEvent, type RealtimeSiteRemovedEvent, type RealtimeSubscribedMessage, type RealtimeSyncCompleteEvent, type RealtimeSyncFailedEvent, type RealtimeSyncJobCompleteEvent, type RealtimeSyncProgressEvent, type RealtimeSyncSiteCompleteEvent, type RegisterPartnerSiteParams, type RegisterPartnerUserParams, type RollupEnvelope, type Row, type ScheduleState, type SearchAppearanceResponse, type SearchAppearanceRow, type SearchTypeOptions, type SiteListItem, type SitemapAddedRow, type SitemapChangesResponse, type SitemapHistoryRecord, type SitemapHistoryResponse, type SitemapIndex, type SitemapRemovedRow, type SourceInfoOptions, type SourceInfoResponse, type TableName, type TableSchema, type TenantCtx, type UpdatePartnerUserTokensParams, type WebhookEnvelope, type WebhookEventType, type WhoamiResponse, analyticsEndpointSchemas, analyticsRoutes };

package/dist/analytics.mjs

@@ -0,0 +1,2 @@
+import { analyticsEndpointSchemas, analyticsRoutes } from "./_chunks/schemas.mjs";
+export { analyticsEndpointSchemas, analyticsRoutes };

package/dist/archetypes.d.mts

@@ -0,0 +1,107 @@
+import { BuilderState, Dimension, GscSearchType, Metric } from "./_chunks/types.mjs";
+type QueryArchetype = 'site-daily-timeseries' | 'entity-daily-timeseries' | 'entity-daily-sparkline' | 'top-n-breakdown' | 'single-row-lookup' | 'multi-series-stacked-daily' | 'two-dimension-detail' | 'arbitrary-sql' | 'aux-cloud-only';
+type ArchetypeExecutionClass = 'r2-sql' | 'r2-sql-resolved' | 'duckdb' | 'cloud-only';
+declare const ARCHETYPE_EXECUTION_CLASS: Record<QueryArchetype, ArchetypeExecutionClass>;
+interface DateRange {
+  start: string;
+  end: string;
+}
+interface ArchetypeFacet {
+  column: Dimension;
+  op: 'eq' | 'regex' | 'notRegex';
+  value: string;
+}
+interface ArchetypeQueryBase {
+  archetype: QueryArchetype;
+  siteId: string;
+  searchType: GscSearchType;
+  range: DateRange;
+  compareRange?: DateRange;
+  facets?: readonly ArchetypeFacet[];
+}
+interface SiteDailyTimeseriesQuery extends ArchetypeQueryBase {
+  archetype: 'site-daily-timeseries';
+  metrics: readonly Metric[];
+}
+interface EntityDailyTimeseriesQuery extends ArchetypeQueryBase {
+  archetype: 'entity-daily-timeseries';
+  entity: {
+    dimension: Extract<Dimension, 'page' | 'query'>;
+    value: string;
+  };
+  metrics: readonly Metric[];
+}
+interface EntityDailySparklineQuery extends ArchetypeQueryBase {
+  archetype: 'entity-daily-sparkline';
+  dimension: Extract<Dimension, 'page' | 'query' | 'queryCanonical'>;
+  entities: readonly string[];
+  metric: Metric;
+}
+interface TopNBreakdownQuery extends ArchetypeQueryBase {
+  archetype: 'top-n-breakdown';
+  dimension: Dimension;
+  metrics: readonly Metric[];
+  orderBy: {
+    metric: Metric;
+    dir: 'asc' | 'desc';
+  };
+  limit: number;
+  offset?: number;
+  includeTotal?: boolean;
+  movers?: 'improving' | 'declining' | 'new' | 'lost';
+}
+interface SingleRowLookupQuery extends ArchetypeQueryBase {
+  archetype: 'single-row-lookup';
+  match: Partial<Record<Dimension, string>>;
+  metrics: readonly Metric[];
+}
+interface MultiSeriesStackedDailyQuery extends ArchetypeQueryBase {
+  archetype: 'multi-series-stacked-daily';
+  seriesDimension: Dimension;
+  metric: Metric;
+}
+interface TwoDimensionDetailQuery extends ArchetypeQueryBase {
+  archetype: 'two-dimension-detail';
+  metrics: readonly Metric[];
+  filter?: {
+    page?: string;
+    query?: string;
+  };
+  orderBy?: {
+    metric: Metric;
+    dir: 'asc' | 'desc';
+  };
+  limit?: number;
+}
+interface ArbitrarySqlQuery extends ArchetypeQueryBase {
+  archetype: 'arbitrary-sql';
+  sql: string;
+  params?: readonly unknown[];
+}
+interface AuxCloudOnlyQuery {
+  archetype: 'aux-cloud-only';
+  siteId: string;
+  dataset: 'canonicals' | 'sitemaps' | 'indexing';
+  params?: Record<string, unknown>;
+}
+type ArchetypeQuery = SiteDailyTimeseriesQuery | EntityDailyTimeseriesQuery | EntityDailySparklineQuery | TopNBreakdownQuery | SingleRowLookupQuery | MultiSeriesStackedDailyQuery | TwoDimensionDetailQuery | ArbitrarySqlQuery | AuxCloudOnlyQuery;
+type ArchetypeResultRow = Record<string, string | number | null>;
+type ArchetypeResultSource = 'browser' | 'server-r2-sql' | 'server-duckdb' | 'cloud';
+interface ArchetypeResult<R extends ArchetypeResultRow = ArchetypeResultRow> {
+  archetype: QueryArchetype;
+  rows: R[];
+  source: ArchetypeResultSource;
+  meta?: {
+    rowCount: number;
+    queryMs: number;
+    totalRows?: number;
+    compareRows?: R[];
+    truncated?: boolean;
+  };
+}
+interface ResolvedArchetypeQuery {
+  query: ArchetypeQuery;
+  builder?: BuilderState;
+  executionClass: ArchetypeExecutionClass;
+}
+export { ARCHETYPE_EXECUTION_CLASS, ArbitrarySqlQuery, ArchetypeExecutionClass, ArchetypeFacet, ArchetypeQuery, ArchetypeQueryBase, ArchetypeResult, ArchetypeResultRow, ArchetypeResultSource, AuxCloudOnlyQuery, DateRange, EntityDailySparklineQuery, EntityDailyTimeseriesQuery, MultiSeriesStackedDailyQuery, QueryArchetype, ResolvedArchetypeQuery, SingleRowLookupQuery, SiteDailyTimeseriesQuery, TopNBreakdownQuery, TwoDimensionDetailQuery };

package/dist/archetypes.mjs

@@ -0,0 +1,12 @@
+const ARCHETYPE_EXECUTION_CLASS = {
+	"site-daily-timeseries": "r2-sql",
+	"entity-daily-timeseries": "r2-sql-resolved",
+	"entity-daily-sparkline": "r2-sql-resolved",
+	"top-n-breakdown": "r2-sql-resolved",
+	"single-row-lookup": "r2-sql",
+	"multi-series-stacked-daily": "r2-sql",
+	"two-dimension-detail": "r2-sql",
+	"arbitrary-sql": "duckdb",
+	"aux-cloud-only": "cloud-only"
+};
+export { ARCHETYPE_EXECUTION_CLASS };